通过


将 Web API 与表定义配合使用

您可以使用 Web API 执行任何表和列定义(元数据)操作,这些操作与使用 .NET SDK 时相同。 本部分提供有关如何将 Web API 与包含的 Web API Metadata Entity Type Reference实体类型配合使用的指导。

Web API 公开四个实体集路径,用于使用定义实体执行操作,如下表所述。

实体集路径 说明
[组织 URI]/api/data/v9.2/EntityDefinitions 包含 EntityMetadata EntityType 的集合。
[组织 URI]/api/data/v9.2/RelationshipDefinitions 包含 ManyToManyRelationshipMetadata EntityTypeOneToManyRelationshipMetadata EntityType ,因为两者都继承自 RelationshipMetadataBase EntityType
[组织 URI]/api/data/v9.2/GlobalOptionSetDefinitions 包含全局定义的 BooleanOptionSetMetadata EntityTypeOptionSetMetadata EntityType 的集合,因为两者都继承自 OptionSetMetadata EntityType
[组织 URI]/api/data/v9.2/ManagedPropertyDefinitions 仅供内部使用

每个定义实体类型都使用 MetadataId 作为唯一标识符属性,该属性从 MetadataBase EntityType 继承。 虽然所有定义实体都有一个 MetadataId,但不能直接查询所有这些实体。 例如,只能在包含这些属性的 EntityMetadata 实体的上下文中查询和执行对属性(表列)的操作。

这些定义实体与存储业务和应用程序数据的表有一些实质性差异,例如:

  • 定义实体的属性使用Web API Complex Type ReferenceWeb API Enum Type Reference中定义的许多复杂类型和枚举类型,而不是用于从crmbaseentity EntityType继承的实体属性的基元数据类型。

  • 定义实体遵循不同的命名约定,并维护 SDK for .NET 程序集中使用的 Pascal Case 命名样式。

  • 定义实体更广泛地使用了继承,这可能需要您进行类型转换以检索所需的数据。

本节内容

使用 Web API 查询表定义
使用 Web API 通过 RESTful 查询风格查询表或列定义。

按名称或 MetadataId 检索表定义
应用程序可以通过查询表和列定义来适应配置更改。 了解定义项的一个关键属性时,可以使用 Web API 检索定义。

使用 Web API 创建和更新表定义
使用 Web API 创建和更新表,以便获得与 .NET CreateEntityRequestUpdateEntityRequest 的 SDK 相同的结果。

使用 Web API 创建和更新列定义
使用 Web API 来创建和更新列,以获得与 SDK for .NET 和 CreateAttributeRequestUpdateAttributeRequest 相同的结果。

使用 Web API 创建和更新表关系
使用 Web API 检查表是否可以与其他表参与关系,然后创建或更新这些关系。

多表查找
多表查找类型列允许用户使用特定表,该表与环境中的其他表具有多个一对多 (1:N) 关系。 单个查找类型列可以引用多个其他表。 提交到多表型列的查询值与任何相关表中的记录相匹配。 可以使用本地表和虚拟表作为引用表来创建多表查找。

使用 Web API 创建和更新选项(选项集)
说明如何处理全局和本地选择列。 如何检索选项值、添加、更新、删除和重新排序选项。

另见

浏览您的环境中的表定义
使用 Microsoft Dataverse Web API
Web API HTTP 表架构操作示例
Web API C# 表架构操作示例
Web API PowerShell 表架构操作示例