通过

适用于 Dynamics 365 渠道集成框架 1.0 的 getEntityMetadata（JavaScript API 参考）

返回指定实体的实体元数据。

Syntax

Microsoft.CIFramework.getEntityMetadata(entityName, attributes).then(successCallback, errorCallback)

参数

Name 类型 必选 Description
entityName String 是的 实体的逻辑名称。
attributes 字符串数组 否 要获取元数据的属性。

退货

类型：对象

说明：包含具有以下属性的实体元数据信息的对象。

属性名称 类型 Description
活动类型掩码 编号 自定义活动是否应显示在 Web 应用程序的活动菜单中。 0 表示不显示自定义活动;1 表示它确实出现。
自动路由到所有者队列 布尔 指示在创建或分配此类型的记录时是否自动将记录移动到所有者的默认队列。
CanEnableSyncToExternalSearch索引 布尔 仅限内部使用。
CanTrigger工作流程 布尔 指示实体是否可以触发工作流进程。
Description String 实体的描述。
显示集合名称 String 实体的复数显示名称。
显示名称 String 实体的显示名称。
强制状态转换 布尔 指示实体是否将强制执行自定义状态转换。
实体颜色 String 十六进制代码，用于表示要在应用程序中用于此实体的颜色。
EntitySetName String 为此实体设置的 Web API 实体的名称。
有活动 布尔 指示作业是否与此实体相关联。
是活动 布尔 指示实体是否为作业。
IsActivityParty （活动方） 布尔 指示电子邮件是否可以发送到存储在此类记录中的电子邮件地址。
IsBusinessProcess已启用 布尔 指示实体是否为业务流程启用。
是BPF实体 布尔 指示实体是否为业务流程实体。
是子实体 布尔 指示实体是否为子实体。
IsConnections启用 布尔 指示是否为此实体启用了连接。
是自定义实体 布尔 指示实体是否为自定义实体。
是可定制的 布尔 指示实体是否可自定义。
IsDocumentManagement已启用 布尔 指示是否启用文档管理。
IsDocumentRecommendations已启用 布尔 指示是否启用文档建议。
IsDuplicateDetection已启用 布尔 指示是否启用重复检测。
IsEnabledForCharts 布尔 指示是否启用图表。
是可移植的 布尔 指示是否可以使用导入向导导入实体。
IsInteractionCentric启用 布尔 指示实体已启用交互式体验。
IsKnowledgeManagement已启用 布尔 指示是否为实体启用了知识管理。
IsMailMerge启用 布尔 指示是否为此实体启用邮件合并。
是托管的 布尔 指示实体是否是托管解决方案的一部分。
IsOneNote集成启用 布尔 指示是否为实体启用了 OneNote 集成。
IsOptimisticConcurrency启用 布尔 指示是否为实体启用了乐观并发。
IsQuickCreate启用 布尔 指示实体是否启用了快速创建窗体。
状态模型感知 布尔 指示实体是否支持设置自定义状态转换。
IsValidForAdvancedFind 布尔 指示实体是否显示在“高级查找”中。
IsVisibleInMobileClient 布尔 指示适用于平板电脑的 Microsoft Dynamics 365 用户是否可以查看此实体的数据。
IsEnabledInUnified接口 布尔 指示实体是否为统一接口启用。
逻辑集合名称 String 逻辑集合名称。
逻辑名称 String 实体的逻辑名称。
对象类型代码 编号 实体类型代码。
所有权类型 String 实体的所有权类型：“UserOwned”或“OrganizationOwned”。
PrimaryId属性 String 作为实体主 ID 的属性的名称。
主图像属性 String 实体的主图像属性的名称。
PrimaryName属性 String 实体的主要属性的名称。
特权 对象数组 实体的权限元数据， 其中每个 对象都包含以下属性，用于定义访问实体的安全权限：
  • CanBeBasic：布尔值。 权限是否可以是基本访问级别。
  • CanBeDeep：布尔值。 权限是否可以是深度访问级别。
  • CanBeEntityReference：布尔值。 外部方的权限是否可以是基本访问级别。
  • CanBeGlobal：布尔值。 权限是否可以是全局访问级别。
  • CanBeLocal：布尔值。 权限是否可以是本地访问级别。
  • CanBeParentEntityReference：布尔值。 外部方的权限是否可以是父访问级别。
  • 名称：字符串。 权限的名称。
  • PrivilegeId：字符串。 权限的 ID。
  • PrivilegeType：数字。 权限类型，为以下类型之一：
    • 0：无
    • 1：创建
    • 2：阅读
    • 3：写入
    • 4：删除
    • 5：分配
    • 6：分享
    • 7：附加
    • 8：附加到
特性 Collection 属性元数据对象的集合。 返回的对象取决于属性元数据的类型。

基类型的属性元数据
返回具有以下属性的对象：

  • AttributeType：数字。 属性的类型。 有关属性类型值的列表，请参阅 AttributeTypeCode
  • DisplayName：字符串。 属性的显示名称。
  • EntityLogicalName：字符串。 包含属性的实体的逻辑名称。
  • LogicalName：字符串。 属性的逻辑名称。

布尔类型的属性元数据
除了 基本 属性元数据类型属性外，还返回以下属性的对象：

  • DefaultFormValue：布尔值。 布尔选项集的默认值。
  • OptionSet：对象。 布尔属性的选项，其中每个选项都是键：值对。

枚举类型的属性元数据
除了 基本 属性元数据类型属性外，还返回以下属性的对象：

  • OptionSet：对象。 属性的选项，其中每个选项都是键：值对。

选项列表类型的属性元数据
除了 基本 属性元数据类型属性外，还返回以下属性的对象：

  • DefaultFormValue：数字。 属性的默认表单值。
  • OptionSet：对象。 属性的选项，其中每个选项都是键：值对。

状态类型的属性元数据
除了 基本 属性元数据类型属性外，还返回以下属性的对象：

  • OptionSet：对象。 属性的选项，其中每个选项都是键：值对。

该对象还包含以下方法：

  • getDefaultStatus（arg）：根据实体传入的状态值返回默认状态（数字）。 有关实体的默认状态和状态值，请参阅 实体引用中实体的实体元数据信息。
  • getStatusValuesForState（arg）：返回指定状态值的可能状态值（数字数组）。 有关实体的状态和状态值，请参阅 实体引用中实体的实体元数据信息。

状态类型的属性元数据
除了 基本 属性元数据类型属性外，还返回以下属性的对象：

  • OptionSet：对象。 属性的选项，其中每个选项都是键：值对。

该对象还包含以下方法：

  • getState（arg）：返回指定状态值（数字）的状态值（数字）。 有关实体的默认状态和状态值，请参阅 实体引用中实体的实体元数据信息。
  • Last updated on