自定义 API 请求参数（CustomAPIRequestParameter）表/实体引用（Microsoft Dataverse）

2025-10-04

为自定义 API 定义请求参数的实体

Messages

下表列出了自定义 API 请求参数（CustomAPIRequestParameter）表的消息。消息表示可以在表上执行的作。它们也可能是事件。

名称是事件？	Web API 操作	SDK for .NET
`Associate` 事件：True	关联记录	关联记录
`Create` 事件：True	`POST` /customapirequestparameters 请参阅创建	创建记录
`Delete` 事件：True	`DELETE` /customapirequestparameters（customapirequestparameterid）请参阅删除	删除记录
`Disassociate` 事件：True	取消关联记录	取消关联记录
`Retrieve` 事件：True	`GET` /customapirequestparameters（customapirequestparameterid）请参阅检索	检索记录
`RetrieveMultiple` 事件：True	`GET` /customapirequestparameters 查看查询数据	查询数据
`Update` 事件：True	`PATCH` /customapirequestparameters（customapirequestparameterid）查看更新	更新记录
`Upsert` 事件：False	`PATCH` /customapirequestparameters（customapirequestparameterid）请参阅更新插入表行	UpsertRequest

属性

下表列出了自定义 API 请求参数（CustomAPIRequestParameter）表的选定属性。

资产	价值
显示名称	自定义 API 请求参数
显示集合名称	自定义 API 请求参数
架构名称	`CustomAPIRequestParameter`
集合架构名称	`CustomAPIRequestParameters`
实体集名称	`customapirequestparameters`
逻辑名称	`customapirequestparameter`
逻辑集合名称	`customapirequestparameters`
PrimaryId属性	`customapirequestparameterid`
PrimaryName属性	`name`
表类型	`Standard`
所有权类型	`None`

可写列/属性

这些列/属性为 IsValidForCreate 或 IsValidForUpdate （通常两者）返回 true。按 SchemaName 列出。

CustomAPIId
CustomAPIRequestParameterId
说明
显示名称
导入序列号
是可定制的
IsOptional
LogicalEntityName
名称
覆盖创建时间
状态代码
状态代码
时区规则版本编号
类型
UniqueName
UTCConversionTimeZoneCode

CustomAPIId

资产	价值
Description	拥有此自定义 API 请求参数的自定义 API 的唯一标识符
显示名称	自定义 API
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`customapiid`
RequiredLevel	系统必填
类型	查找
Targets	自定义API

CustomAPIRequestParameterId

资产	价值
Description	自定义 API 请求参数实例的唯一标识符
显示名称	自定义 API 请求参数
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`customapirequestparameterid`
RequiredLevel	系统必填
类型	Uniqueidentifier

Description

资产	价值
Description	自定义 API 请求参数实例的本地化说明
显示名称	说明
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`description`
RequiredLevel	申请必填
类型	String
Format	文本
格式名称	文本
ImeMode	Auto
是可本地化的	True
MaxLength （最大长度）	300

显示名称

资产	价值
Description	自定义 API 请求参数实例的本地化显示名称
显示名称	显示名称
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`displayname`
RequiredLevel	申请必填
类型	String
Format	文本
格式名称	文本
ImeMode	Auto
是可本地化的	True
MaxLength （最大长度）	100

ImportSequenceNumber

资产	价值
Description	创建此记录的导入的序列号。
显示名称	导入序列号
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`importsequencenumber`
RequiredLevel	None
类型	整数
最大值	2147483647
最小值	-2147483648

IsCustomizable

资产	价值
Description	仅供内部使用。
显示名称	可定制
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`iscustomizable`
RequiredLevel	系统必填
类型	ManagedProperty

IsOptional

资产	价值
Description	指示自定义 API 请求参数是否为可选
显示名称	是可选的
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`isoptional`
RequiredLevel	系统必填
类型	布尔
全局选择名称	`customapirequestparameter_isoptional`
默认值	假
真实标签	是的
虚假标签	否

LogicalEntityName

资产	价值
Description	绑定到自定义 API 请求参数的实体的逻辑名称
显示名称	绑定实体逻辑名称
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`logicalentityname`
RequiredLevel	None
类型	String
Format	文本
格式名称	文本
ImeMode	Auto
是可本地化的	假
MaxLength （最大长度）	100

Name

资产	价值
Description	自定义 API 请求参数的主要名称
显示名称	名称
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`name`
RequiredLevel	申请必填
类型	String
Format	文本
格式名称	文本
ImeMode	Auto
是可本地化的	假
MaxLength （最大长度）	100

OverriddenCreatedOn

资产	价值
Description	迁移记录的日期和时间。
显示名称	记录创建时间
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`overriddencreatedon`
RequiredLevel	None
类型	日期时间
可以更改日期时间行为	假
日期时间行为	用户本地
Format	DateOnly
ImeMode	未激活
源类型掩码	0

statecode

资产	价值
Description	自定义 API 请求参数的状态
显示名称	地位
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	系统必填
类型	State
默认表单值
全局选择名称	`customapirequestparameter_statecode`

statecode 选择/选项

价值	详细信息
0	标签：活跃默认状态：1 不变量名称： `Active`
1	标签：不活跃默认状态：2 不变量名称： `Inactive`

状态码

资产	价值
Description	自定义 API 请求参数状态的原因
显示名称	状态描述
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`statuscode`
RequiredLevel	None
类型	状态
默认表单值
全局选择名称	`customapirequestparameter_statuscode`

statuscode 选项/选项

价值	详细信息
1	标签：活跃状态：0 TransitionData：无
2	标签：不活跃状态：1 TransitionData：无

时区规则版本编号

资产	价值
Description	仅供内部使用。
显示名称	时区规则版本号
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`timezoneruleversionnumber`
RequiredLevel	None
类型	整数
最大值	2147483647
最小值	-1

类型

资产	价值
Description	自定义 API 请求参数的数据类型
显示名称	类型
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`type`
RequiredLevel	系统必填
类型	选择列表
默认表单值	0
全局选择名称	`customapifieldtype`

类型选择/选项

价值	标签
0	布尔值
1	日期时间
2	十进制
3	实体
4	实体集合
5	EntityReference
6	流通股
7	整数
8	钱
9	选项列表
10	字符串
11	StringArray
12	Guid

唯一名称

资产	价值
Description	自定义 API 请求参数的唯一名称
显示名称	唯一名称
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`uniquename`
RequiredLevel	系统必填
类型	String
Format	文本
格式名称	文本
ImeMode	Auto
是可本地化的	假
MaxLength （最大长度）	128

UTCConversionTimeZoneCode

资产	价值
Description	创建记录时正在使用的时区代码。
显示名称	UTC 转换时区代码
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`utcconversiontimezonecode`
RequiredLevel	None
类型	整数
最大值	2147483647
最小值	-1

只读列/属性

这些列/属性为 IsValidForCreate 和 IsValidForUpdate 返回 false。按 SchemaName 列出。

组件 IdUnique
组件状态
CreatedBy
创建时间
创建时BehalfBy
是托管的
ModifiedBy
修改时间
ModifiedOnBehalfBy
覆盖时间
所有者 ID
所有者 IdType
拥有业务单位
拥有团队
拥有用户
解决方案 ID
支持解决方案 Id
版本编号

组件 IdUnique

资产	价值
Description	仅供内部使用。
显示名称	行 ID 唯一
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`componentidunique`
RequiredLevel	系统必填
类型	Uniqueidentifier

组件状态

资产	价值
Description	仅供内部使用。
显示名称	组件状态
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`componentstate`
RequiredLevel	系统必填
类型	选择列表
默认表单值
全局选择名称	`componentstate`

ComponentState 选择/选项

价值	标签
0	已发布
1	未发布
2	已删除
3	已删除，未发布

CreatedBy

资产	价值
Description	创建记录的用户的唯一标识符。
显示名称	创建者
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`createdby`
RequiredLevel	None
类型	查找
Targets	systemuser

CreatedOn

资产	价值
Description	创建记录的日期和时间。
显示名称	创建时间
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`createdon`
RequiredLevel	None
类型	日期时间
可以更改日期时间行为	假
日期时间行为	用户本地
Format	日期和时间
ImeMode	未激活
源类型掩码	0

创建时BehalfBy

资产	价值
Description	创建记录的委托用户的唯一标识符。
显示名称	创建者（委托）
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`createdonbehalfby`
RequiredLevel	None
类型	查找
Targets	systemuser

IsManaged

资产	价值
Description	指示解决方案组件是否是托管解决方案的一部分。
显示名称	受管理
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`ismanaged`
RequiredLevel	系统必填
类型	布尔
全局选择名称	`ismanaged`
默认值	假
真实标签	托管
虚假标签	非托管

ModifiedBy

资产	价值
Description	修改记录的用户的唯一标识符。
显示名称	修改者
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`modifiedby`
RequiredLevel	None
类型	查找
Targets	systemuser

修改时间

资产	价值
Description	修改记录的日期和时间。
显示名称	修改时间
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`modifiedon`
RequiredLevel	None
类型	日期时间
可以更改日期时间行为	假
日期时间行为	用户本地
Format	日期和时间
ImeMode	未激活
源类型掩码	0

ModifiedOnBehalfBy

资产	价值
Description	修改记录的委托用户的唯一标识符。
显示名称	修改者（委托）
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`modifiedonbehalfby`
RequiredLevel	None
类型	查找
Targets	systemuser

覆盖时间

资产	价值
Description	仅供内部使用。
显示名称	记录覆盖时间
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`overwritetime`
RequiredLevel	系统必填
类型	日期时间
可以更改日期时间行为	假
日期时间行为	用户本地
Format	日期和时间
ImeMode	未激活
源类型掩码	0

OwnerId

资产	价值
Description	所有者 ID
显示名称	Owner
IsValidForForm （形式有效）	True
IsValidForRead	True
LogicalName	`ownerid`
RequiredLevel	系统必填
类型	所有者
Targets	系统用户，团队

所有者 IdType

资产	价值
Description	所有者 ID 类型
显示名称	所有者 ID 类型
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`owneridtype`
RequiredLevel	系统必填
类型	实体名称

拥有业务单位

资产	价值
Description	拥有记录的业务部门的唯一标识符
显示名称	拥有业务单位
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`owningbusinessunit`
RequiredLevel	None
类型	查找
Targets	业务单位

拥有团队

资产	价值
Description	拥有记录的团队的唯一标识符。
显示名称	拥有团队
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`owningteam`
RequiredLevel	None
类型	查找
Targets	团队

拥有用户

资产	价值
Description	拥有记录的用户的唯一标识符。
显示名称	拥有用户
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`owninguser`
RequiredLevel	None
类型	查找
Targets	systemuser

解决方案 ID

资产	价值
Description	关联解决方案的唯一标识符。
显示名称	Solution
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`solutionid`
RequiredLevel	系统必填
类型	Uniqueidentifier

支持解决方案 Id

资产	价值
Description	仅供内部使用。
显示名称	Solution
IsValidForForm （形式有效）	假
IsValidForRead	假
LogicalName	`supportingsolutionid`
RequiredLevel	None
类型	Uniqueidentifier

版本号

资产	价值
Description	版本号
显示名称	版本号
IsValidForForm （形式有效）	假
IsValidForRead	True
LogicalName	`versionnumber`
RequiredLevel	None
类型	BigInt
最大值	9223372036854775807
最小值	-9223372036854775808

多对一关系

这些关系是多对一的。按 SchemaName 列出。

customapi_customapirequestparameter
lk_customapirequestparameter_createdby
lk_customapirequestparameter_createdonbehalfby
lk_customapirequestparameter_modifiedby
lk_customapirequestparameter_modifiedonbehalfby

customapi_customapirequestparameter

单To-Many 关系： customapi customapi_customapirequestparameter

资产	价值
引用实体	`customapi`
引用属性	`customapiid`
引用属性	`customapiid`
ReferencingEntityNavigationPropertyName	`CustomAPIId`
是层次结构
级联配置	档案： `NoCascade` 分配： `NoCascade` 删除： `Cascade` 合并： `NoCascade` 重新父级： `Cascade` RollupView： `NoCascade` 共享： `NoCascade` 取消分享： `NoCascade`

lk_customapirequestparameter_createdby

单To-Many 关系： systemuser lk_customapirequestparameter_createdby

资产	价值
引用实体	`systemuser`
引用属性	`systemuserid`
引用属性	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
是层次结构
级联配置	档案： `NoCascade` 分配： `NoCascade` 删除： `NoCascade` 合并： `NoCascade` 重新父级： `NoCascade` RollupView： `NoCascade` 共享： `NoCascade` 取消分享： `NoCascade`

lk_customapirequestparameter_createdonbehalfby

一To-Many 关系： systemuser lk_customapirequestparameter_createdonbehalfby

资产	价值
引用实体	`systemuser`
引用属性	`systemuserid`
引用属性	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
是层次结构
级联配置	档案： `NoCascade` 分配： `NoCascade` 删除： `NoCascade` 合并： `NoCascade` 重新父级： `NoCascade` RollupView： `NoCascade` 共享： `NoCascade` 取消分享： `NoCascade`

lk_customapirequestparameter_modifiedby

一To-Many 关系： systemuser lk_customapirequestparameter_modifiedby

资产	价值
引用实体	`systemuser`
引用属性	`systemuserid`
引用属性	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
是层次结构
级联配置	档案： `NoCascade` 分配： `NoCascade` 删除： `NoCascade` 合并： `NoCascade` 重新父级： `NoCascade` RollupView： `NoCascade` 共享： `NoCascade` 取消分享： `NoCascade`

lk_customapirequestparameter_modifiedonbehalfby

一To-Many 关系： systemuser lk_customapirequestparameter_modifiedonbehalfby

资产	价值
引用实体	`systemuser`
引用属性	`systemuserid`
引用属性	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
是层次结构
级联配置	档案： `NoCascade` 分配： `NoCascade` 删除： `NoCascade` 合并： `NoCascade` 重新父级： `NoCascade` RollupView： `NoCascade` 共享： `NoCascade` 取消分享： `NoCascade`

一对多关系

这些关系是一对多的。按 SchemaName 列出。

customapirequestparameter_AsyncOperations
customapirequestparameter_BulkDeleteFailures
customapirequestparameter_MailboxTrackingFolders
customapirequestparameter_PrincipalObjectAttributeAccesses
customapirequestparameter_ProcessSession
customapirequestparameter_SyncErrors

customapirequestparameter_AsyncOperations

多To-One 关系：异步customapirequestparameter_AsyncOperations

资产	价值
引用实体	`asyncoperation`
引用属性	`regardingobjectid`
引用实体导航属性名称	`customapirequestparameter_AsyncOperations`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

customapirequestparameter_BulkDeleteFailures

多To-One 关系： bulkdeletefailure customapirequestparameter_BulkDeleteFailures

资产	价值
引用实体	`bulkdeletefailure`
引用属性	`regardingobjectid`
引用实体导航属性名称	`customapirequestparameter_BulkDeleteFailures`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

customapirequestparameter_MailboxTrackingFolders

多To-One 关系： mailboxtrackingfolder customapirequestparameter_MailboxTrackingFolders

资产	价值
引用实体	`mailboxtrackingfolder`
引用属性	`regardingobjectid`
引用实体导航属性名称	`customapirequestparameter_MailboxTrackingFolders`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

customapirequestparameter_PrincipalObjectAttributeAccesses

多To-One 关系： principalobjectattributeaccess customapirequestparameter_PrincipalObjectAttributeAccesses

资产	价值
引用实体	`principalobjectattributeaccess`
引用属性	`objectid`
引用实体导航属性名称	`customapirequestparameter_PrincipalObjectAttributeAccesses`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

customapirequestparameter_ProcessSession

多To-One 关系： processsession customapirequestparameter_ProcessSession

资产	价值
引用实体	`processsession`
引用属性	`regardingobjectid`
引用实体导航属性名称	`customapirequestparameter_ProcessSession`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

customapirequestparameter_SyncErrors

多To-One 关系：同步器customapirequestparameter_SyncErrors

资产	价值
引用实体	`syncerror`
引用属性	`regardingobjectid`
引用实体导航属性名称	`customapirequestparameter_SyncErrors`
IsCustomizable	`True`
关联菜单配置	可用离线：True 行为： `DoNotDisplay` 群： `Details` 标签： MenuId：空次序： QueryApi：空视图 ID： `00000000-0000-0000-0000-000000000000`

另请参阅

Dataverse 表/实体引用
 Dataverse Web API 参考
 customapirequestparameter

反馈

此页面是否有帮助？