CustomAPI 表

定义自定义 API 的数据位于下表/实体中:

本文中的各节提供有关最常用的列值的详细信息。

此图显示了表如何与这些表和其他表相关:

显示表之间的关系的关系图。

CatalogAssignment 表 的关系允许将自定义 API 与 Microsoft Dataverse 业务事件配合使用。 详细信息:目录表和 CatalogAssignment 表

检索有关自定义 API 的数据

可以使用以下查询检索有关自定义 API 的数据。

详细信息: 使用 Web API 查询数据

GET [Organization URI]/api/data/v9.1/customapis?$select=
    uniquename,
    allowedcustomprocessingsteptype,
    bindingtype,
    boundentitylogicalname,
    description,
    displayname,
    executeprivilegename,
    iscustomizable,
    isfunction,
    isprivate,
    workflowsdkstepenabled
  &$expand=
  CustomAPIRequestParameters($select=
    uniquename,
    name,
    description,
    displayname,
    type,
    logicalentityname,
    iscustomizable,
    isoptional),
  CustomAPIResponseProperties($select=
    uniquename,
    name,
    description,
    displayname,
    iscustomizable,
    type,
    logicalentityname),
  PluginTypeId($select=
    plugintypeid,
    typename,
    version,
    name,
    assemblyname)

自定义 API 表列

下表包含可以设置的自定义 API 表的选定列。

显示名称
架构名称
逻辑名称
类型 Description
允许的自定义处理步骤类型
AllowedCustomProcessingStepType
allowedcustomprocessingsteptype
选择
选择列表
  • :0
    标签:无
    含义:不允许自定义处理步骤。
  • :1
    标签:仅异步
    含义:仅允许异步自定义处理步骤
  • Value:2
    标签:同步和异步
    含义:没有限制。 第三方插件可以添加同步逻辑来更改消息的行为。
请参阅 选择自定义处理步骤类型
保存后无法更改。
绑定类型
BindingType
bindingtype
选择
选择列表
  • :0 标签:全局
  • :1 标签:实体
  • :2 标签:EntityCollection
请参阅 “选择绑定类型”
保存后无法更改。
绑定的实体逻辑名称
BoundEntityLogicalName
boundentitylogicalname
文本
String
绑定到自定义 API(如果不是全局)的表的逻辑名称。
保存后无法更改。
自定义 API
CustomAPIId
customapiid
唯一标识符
Guid
自定义 API 实例的唯一标识符
保存后无法更改。
说明
Description
description
文本
String
此自定义 API 的本地化说明。 当消息在应用中可见时,请使用此值。 例如,作为 工具提示
显示名称
DisplayName
displayname
文本
String
此自定义 API 的本地化显示名称。 当消息在应用中可见时,请使用此值。
执行权限名称
ExecutePrivilegeName
executeprivilegename
文本
String
(可选)允许执行自定义 API 的权限的名称。 请参阅: 通过要求特权来保护自定义 API
可自定义
IsCustomizable
iscustomizable
ManagedProperty 自定义 API 是否可以在托管解决方案的一部分时进行自定义或删除。
函数
IsFunction
isfunction
Yes/No
布尔
  • :0 标签:否
  • :1 标签:是
查看 何时创建函数
保存后无法更改。
专用
IsPrivate
isprivate
Yes/No
布尔
  • :0 标签:否
  • :1 标签:是
查看 何时将自定义 API 设为专用
名称
Name
name
文本
String
自定义 API 的主要名称。 在解决方案中查看时,此值显示在自定义 API 列表中。
Owner
OwnerId
ownerid
所有者 对拥有 API 的用户或团队的引用。
插件类型
PluginTypeId
plugintypeid
查找 对提供此自定义 API 主要操作的插件类型的引用。 请参阅:通过插件在自定义 API 中集成逻辑
唯一名称
UniqueName
uniquename
文本
String
自定义 API 的唯一名称。 此值是创建的消息的名称。
此值必须包含与解决方案发布者设置的前缀匹配的自定义前缀。
此值不能包含任何特殊字符。
保存后无法更改。
已对工作流启用
WorkflowSdkStepEnabled
workflowsdkstepenabled
Yes/No
布尔
指示是否将自定义 API 启用为工作流操作。 请参阅: 在工作流中使用自定义 API
保存后无法更改。

CustomAPIRequestParameter 表列

定制 API 不需要任何参数。 参数没有指定顺序。 它们被按名称标识。

参数与单个自定义 API 相关。 不能定义多个自定义 API 来使用相同的参数定义。 如果多个请求参数由不同的自定义 API 使用,则可以使用相同的值来定义这些参数 UniqueName

注释

如果为自定义 API 定义绑定表,将为你生成请求参数。 当自定义 API 绑定到表时,无需为表创建输入参数。 详细信息: 选择绑定类型

下表包含可以设置的自定义 API 请求参数表的列(属性)。

显示名称
架构名称
逻辑名称
类型 Description
自定义 API 请求参数
CustomAPIRequestParameterId
customapirequestparameterid
唯一标识符
Guid
自定义 API 请求参数实例的唯一标识符。
保存后无法更改。
自定义 API
CustomAPIId
customapiid
查找 与此自定义 API 请求参数关联的自定义 API 的唯一标识符。
保存后无法更改。
说明
Description
description
文本
String
自定义 API 请求参数实例的本地化说明。 当消息参数在应用中可见时,请使用此值。 例如,作为 工具提示
显示名称
DisplayName
displayname
文本
String
自定义 API 请求参数实例的本地化显示名称。 当消息参数在应用中可见时,请使用此值。
可自定义
IsCustomizable
iscustomizable
ManagedProperty 自定义 API 请求参数在托管解决方案的一部分时是否可以自定义或删除。 请参阅 API 自定义
可选
IsOptional
isoptional
Yes/No
布尔
指示自定义 API 请求参数是否可选。 如果不是可选的,则使用消息时需要传递此参数的值。
  • :0 标签:否
  • :1 标签:是
保存后无法更改。
逻辑实体名称
LogicalEntityName
logicalentityname
文本
String
绑定到自定义 API 请求参数的表的逻辑名称。
保存后无法更改。
名称
Name
name
文本
String
自定义 API 请求参数的主要名称。 在解决方案中查看时,此值显示在自定义 API 请求参数列表中。 使用此值可将此参数与共享公用唯一名称的其他参数区分开来。
建议使用此命名约定: {custom API Unique Name}.{Parameter UniqueName}
Owner
OwnerId
ownerid
所有者 对拥有 API 的用户或团队的引用。
类型
Type
type
选择
选择列表
自定义 API 请求参数的数据类型。
  • :0 标签:布尔值
  • :1 标签:"DateTime"
  • :2 标签:十进制
  • :3 标签:实体
  • :4 标签:实体集合 (EntityCollection)
  • :5 标签:EntityReference
  • :6 标签:浮点数
  • :7 标签:整数
  • :8 标签:货币
  • :9 标签:选取列表
  • :10 标签:字符串
  • :11 标签:StringArray
  • :12 标签:Guid
保存后无法更改。
唯一名称
UniqueName
uniquename
文本
String
自定义 API 请求参数的唯一名称。 调用自定义 API 时,此值是参数的名称。
此值不能包含任何特殊字符。
保存后无法更改。

CustomAPIResponseProperty 表列

为自定义 API 消息返回的对象包括你定义的任何响应属性。 自定义 API作不需要返回任何值,但如果定义为函数,则必须返回值。

如果只定义了一个 Entity 或 EntityCollection 响应属性,则响应属于该类型。 如果有多个参数或一个或多个简单类型的参数,API 将返回一个复杂类型,其中每个响应属性都是该复杂类型的属性。

例如,如果自定义 API 唯一名称 sample_CustomAPIExample,它将返回一个复杂 sample_CustomAPIExampleResponse 类型,其中包含定义的每个响应属性的属性。

下表包含可以设置的自定义 API 响应属性表的列(属性)。

显示名称
架构名称
逻辑名称
类型 Description
自定义 API 响应属性
CustomAPIResponsePropertyId
customapiresponsepropertyid
唯一标识符
Guid
自定义 API 响应属性实例的唯一标识符。
保存后无法更改。
自定义 API
CustomAPIId
customapiid
查找 与此自定义 API 响应属性关联的自定义 API 的唯一标识符。
保存后无法更改。
说明
Description
description
文本
String
自定义 API 响应属性实例的本地化说明。 当消息参数在应用中可见时,请使用此值。 例如,作为 工具提示
显示名称
DisplayName
displayname
文本
String
自定义 API 响应属性实例的本地化显示名称。 当消息参数在应用中可见时,请使用此值。
可自定义
IsCustomizable
iscustomizable
ManagedProperty 自定义 API 响应属性在托管解决方案的一部分时是否可以自定义或删除。
逻辑实体名称
LogicalEntityName
logicalentityname
文本
String
选择 实体EntityReference 作为 类型时,可以指定绑定到自定义 API 响应属性的表的逻辑名称。 选择实体集合作为类型时,不能指定逻辑实体名称
保存后无法更改。
名称
Name
name
String 自定义 API 响应属性的主名称。 在解决方案中查看时,此值显示在自定义 API 请求参数列表中。 使用此值可将此参数与共享公用唯一名称的其他参数区分开来。
建议使用此命名约定: {custom API Unique Name}.{Property UniqueName}
Owner
OwnerId
ownerid
所有者 对拥有 API 的用户或团队的引用。
类型
Type
type
选择列表 自定义 API 响应属性的数据类型
  • :0 标签:布尔值
  • :1 标签:"DateTime"
  • :2 标签:十进制
  • :3 标签:实体
  • :4 标签:实体集合 (EntityCollection)
  • :5 标签:EntityReference
  • :6 标签:浮点数
  • :7 标签:整数
  • :8 标签:货币
  • :9 标签:选取列表
  • :10 标签:字符串
  • :11 标签:StringArray
  • :12 标签:Guid
保存后无法更改。
唯一名称
UniqueName
uniquename
文本
String
自定义 API 响应属性的唯一名称。 调用自定义 API 时,此值是参数的名称。
此值不能包含任何特殊字符。
保存后无法更改。

另请参阅

创建和使用自定义 API
使用插件注册工具创建自定义 API
在 Power Apps 中创建自定义 API
使用代码创建自定义 API
使用解决方案文件创建自定义 API
创建自己的邮件