通过

getEntityMetadata （客户端 API）

返回指定表的表定义。

Syntax

Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)

参数

Name 类型 必选 Description
entityName String 是的 表的逻辑名称。
attributes 字符串数组 否 要获取其定义的列。
successCallback 函数 否 返回表定义时要调用的函数。
errorCallback 函数 否 作失败时要调用的函数。

退货

类型：对象

说明：一个对象，其中包含具有以下值的表定义信息。

Name 类型 Description
ActivityTypeMask 编号 自定义活动是否应显示在 Web 应用程序的活动菜单中。 0 指示不会显示自定义活动; 1 指示它确实出现。
AutoRouteToOwnerQueue 布尔 指示创建或分配此类型的记录时是否自动将记录移动到所有者的默认队列。
CanEnableSyncToExternalSearchIndex 布尔 仅供内部使用。
CanTriggerWorkflow 布尔 指示表是否可以触发工作流进程。
Description String 表的说明。
DisplayCollectionName String 表的复数显示名称。
DisplayName String 表的显示名称。
EnforceStateTransitions 布尔 指示表是否将强制实施自定义状态转换。
EntityColor String 表示要用于应用程序中此表的颜色的十六进制代码。
EntitySetName String 为此表设置的 Web API 表的名称。
HasActivities 布尔 指示活动是否与此表关联。
IsActivity 布尔 指示表是否为活动。
IsActivityParty 布尔 指示电子邮件是否可以发送到存储在此类记录中的电子邮件地址。
IsBusinessProcessEnabled 布尔 指示是否为业务流程启用了表。
IsBPFEntity 布尔 指示表是否为业务流程表。
IsChildEntity 布尔 指示表是否为子表。
IsConnectionsEnabled 布尔 指示是否为此表启用了连接。
IsCustomEntity 布尔 指示表是否为自定义表。
IsCustomizable 布尔 指示表是否可自定义。
IsDocumentManagementEnabled 布尔 指示是否启用文档管理。
IsDocumentRecommendationsEnabled 布尔 指示是否启用文档建议。
IsDuplicateDetectionEnabled 布尔 指示是否启用重复检测。
IsEnabledForCharts 布尔 指示是否启用图表。
IsImportable 布尔 指示是否可以使用导入向导导入表。
IsInteractionCentricEnabled 布尔 指示已为交互式体验启用表。
IsKnowledgeManagementEnabled 布尔 指示是否为表启用了知识管理。
IsMailMergeEnabled 布尔 指示是否为此表启用了邮件合并。
IsManaged 布尔 指示表是否是托管解决方案的一部分。
IsOneNoteIntegrationEnabled 布尔 指示是否为表启用了 OneNote 集成。
IsOptimisticConcurrencyEnabled 布尔 指示是否为表启用了乐观并发。
IsQuickCreateEnabled 布尔 指示是否为快速创建表单启用了表。
IsStateModelAware 布尔 指示表是否支持设置自定义状态转换。
IsValidForAdvancedFind 布尔 指示表是否将显示在高级查找中。
IsVisibleInMobileClient 布尔 指示 Microsoft Dynamics 365 for tablets 用户是否可以查看此表的数据。
IsEnabledInUnifiedInterface 布尔 指示是否为统一接口启用表。
LogicalCollectionName String 逻辑集合名称。
LogicalName String 表的逻辑名称。
ObjectTypeCode 编号 表类型代码。
OwnershipType String 表的所有权类型： UserOwned 或 OrganizationOwned。
PrimaryIdAttribute String 列的名称，该列是表的主 ID。
PrimaryImageAttribute String 表的主图像列的名称。
PrimaryNameAttribute String 表的主列的名称。
Privileges 对象数组 定义访问表的安全特权的对象。 请参阅 Privilege 对象
Attributes Collection 列定义对象的集合。 请参阅 Attribute 对象

Privilege 对象

特权对象具有以下属性，用于定义访问表的安全特权：

Name 类型 Description
CanBeBasic 布尔 权限是否可以是基本访问级别。
CanBeDeep 布尔 权限是否可以是深度访问级别。
CanBeEntityReference 布尔 外部方的权限是否可以是基本访问级别。
CanBeGlobal 布尔 权限是否可以是全局访问级别。
CanBeLocal 布尔 权限是否可以是本地访问级别。
CanBeParentEntityReference 布尔 外部方的权限是否可以是父访问级别。
Name String 权限的名称。
PrivilegeId String 权限的 ID。
PrivilegeType 编号 权限类型，为以下类型之一：
0 ： 无
1：创建
2： 读取
3：写入
4：删除
5： 分配
6： 共享
7：追加
8：AppendTo

属性对象

返回的对象取决于列定义的类型。

Base （AttributeMetadata） 列

所有列定义都具有以下共享属性：

Name 类型 Description
AttributeType 编号 列的类型。 有关列类型值的列表，请参阅 AttributeTypeCode 枚举
DisplayName String 列的显示名称
EntityLogicalName String 包含列的表的逻辑名称。
LogicalName String 列的逻辑名称。

是/否 （BooleanAttributeMetadata） 列

是/否列具有以下属性：

Name 类型 Description
DefaultFormValue 布尔 “是/否”列的默认值。
OptionSet 物体 布尔列的选项，其中每个选项都是键：值对。

Choice （PicklistAttributeMetadata） 列

选择列具有此属性：

Name 类型 Description
OptionSet 物体 每个选项都是键：值对的列的选项。

选项 （MultiSelectPicklistAttributeMetadata） 列

选项列具有以下属性：

Name 类型 Description
DefaultFormValue 布尔 列的默认值。
OptionSet 物体 布尔列的选项，其中每个选项都是键：值对。

State （StateAttributeMetadata） 列

状态列具有此属性：

Name 类型 Description
OptionSet 物体 每个选项都是键：值对的列的选项。

状态列还具有接受选项值arg之一OptionSet作为参数的值的方法。

Name 返回类型 Description
getDefaultStatus(arg) 编号 根据表的传入状态值返回默认状态（数字）。 有关表的默认状态和状态值，请参阅 Dataverse 表/实体引用中表的表定义信息。
getStatusValuesForState(arg) 数字数组 返回指定状态值的可能状态值（数字数组）。 有关表的状态和状态值，请参阅 Dataverse 表/实体引用中表的表定义信息。

状态 （StatusAttributeMetadata） 列

状态列具有此属性：

Name 类型 Description
OptionSet 物体 每个选项都是键：值对的列的选项。

状态列还具有此方法，该方法接受选项 OptionSet 值之一作为 arg 参数的值。

Name 返回类型 Description
getState(arg) 编号 返回指定状态值（number）的状态值（数字）。 有关表的默认状态和状态值，请参阅 Dataverse 表/实体引用中表的表定义信息。

Xrm.Utility