Поделиться через


getEntityMetadata (клиентский API)

Возвращает определения таблиц для указанной таблицы.

Синтаксис

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

Параметры

Имя Тип Обязательно Description
entityName String Да Логическое имя таблицы.
attributes Массив строк нет Столбцы для получения определений.
successCallback function нет Функция для вызова при возврате определений таблиц.
errorCallback function нет Функция, вызываемая при сбое операции.

Возвраты

Тип: Объект

Описание. Объект, содержащий сведения о определениях таблиц со следующими значениями.

Имя Тип Description
ActivityTypeMask Number Должно ли пользовательское действие отображаться в меню действий в веб-приложении. 0 указывает, что настраиваемое действие не отображается; 1 указывает, что он отображается.
AutoRouteToOwnerQueue Boolean Указывает, следует ли автоматически перемещать записи в очередь владельца по умолчанию при создании или назначении записи этого типа.
CanEnableSyncToExternalSearchIndex Boolean Только для внутреннего использования.
CanTriggerWorkflow Boolean Указывает, может ли таблица активировать процесс рабочего процесса.
Description String Описание таблицы.
DisplayCollectionName String Отображаемое имя множественного числа для таблицы.
DisplayName String Отображаемое имя таблицы.
EnforceStateTransitions Boolean Указывает, будет ли таблица применять пользовательские переходы состояния.
EntityColor String Шестнадцатеричный код, представляющий цвет, используемый для этой таблицы в приложении.
EntitySetName String Имя таблицы веб-API, заданной для этой таблицы.
HasActivities Boolean Указывает, связаны ли действия с этой таблицей.
IsActivity Boolean Указывает, является ли таблица действием.
IsActivityParty Boolean Указывает, могут ли сообщения электронной почты отправляться на адрес электронной почты, хранящийся в записи этого типа.
IsBusinessProcessEnabled Boolean Указывает, включена ли таблица для потоков бизнес-процессов.
IsBPFEntity Boolean Указывает, является ли таблица таблицей потока бизнес-процессов.
IsChildEntity Boolean Указывает, является ли таблица дочерней.
IsConnectionsEnabled Boolean Указывает, включены ли подключения для этой таблицы.
IsCustomEntity Boolean Указывает, является ли таблица пользовательской.
IsCustomizable Boolean Указывает, настраивается ли таблица.
IsDocumentManagementEnabled Boolean Указывает, включено ли управление документами.
IsDocumentRecommendationsEnabled Boolean Указывает, включены ли рекомендации по документу.
IsDuplicateDetectionEnabled Boolean Указывает, включено ли обнаружение дубликатов.
IsEnabledForCharts Boolean Указывает, включены ли диаграммы.
IsImportable Boolean Указывает, можно ли импортировать таблицу с помощью мастера импорта.
IsInteractionCentricEnabled Boolean Указывает, что таблица включена для интерактивного взаимодействия.
IsKnowledgeManagementEnabled Boolean Указывает, включено ли управление знаниями для таблицы.
IsMailMergeEnabled Boolean Указывает, включена ли слияние почты для этой таблицы.
IsManaged Boolean Указывает, является ли таблица частью управляемого решения.
IsOneNoteIntegrationEnabled Boolean Указывает, включена ли интеграция OneNote для таблицы.
IsOptimisticConcurrencyEnabled Boolean Указывает, включена ли оптимистическая параллелизм для таблицы.
IsQuickCreateEnabled Boolean Указывает, включена ли таблица для быстрого создания форм.
IsStateModelAware Boolean Указывает, поддерживает ли таблица настройку пользовательских переходов состояния.
IsValidForAdvancedFind Boolean Указывает, будет ли таблица отображаться в расширенном поиске.
IsVisibleInMobileClient Boolean Указывает, могут ли пользователи Microsoft Dynamics 365 для планшетов просматривать данные для этой таблицы.
IsEnabledInUnifiedInterface Boolean Указывает, включена ли таблица для единого интерфейса.
LogicalCollectionName String Имя логической коллекции.
LogicalName String Логическое имя таблицы.
ObjectTypeCode Number Код типа таблицы.
OwnershipType String Тип владения для таблицы: UserOwned или OrganizationOwned.
PrimaryIdAttribute String Имя столбца, который является основным идентификатором таблицы.
PrimaryImageAttribute String Имя столбца основного изображения для таблицы.
PrimaryNameAttribute String Имя основного столбца таблицы.
Privileges Массив объектов Объекты, определяющие привилегию безопасности для доступа к таблице. См . объект Privilege
Attributes Коллекция Коллекция объектов определений столбцов. См . объекты атрибутов

Объект Privilege

Объекты привилегий имеют следующие свойства, чтобы определить привилегии безопасности для доступа к таблице:

Имя Тип Description
CanBeBasic Boolean Может ли привилегия быть базовым уровнем доступа.
CanBeDeep Boolean Может ли привилегия быть глубокого уровня доступа.
CanBeEntityReference Boolean Может ли привилегия для внешней стороны быть базовым уровнем доступа.
CanBeGlobal Boolean Может ли привилегия быть глобальным уровнем доступа.
CanBeLocal Boolean Может ли привилегия быть локальным уровнем доступа.
CanBeParentEntityReference Boolean Может ли привилегия для внешней стороны быть родительским уровнем доступа.
Name String Имя привилегии.
PrivilegeId String Идентификатор привилегии.
PrivilegeType Number Тип привилегии, который является одним из следующих:
0: нет
1. Создание
2. Чтение
3. Запись
4. Удаление
5. Назначение
6. Общий доступ
7. Добавление
8. Добавление

Объекты атрибутов

Возвращаемый объект зависит от типа определений столбцов.

Столбцы Base (AttributeMetadata)

Все определения столбцов имеют следующие общие свойства:

Имя Тип Description
AttributeType Number Тип столбца. Список значений типа столбца см. в разделе "Enum AttributeTypeCode"
DisplayName String Отображаемое имя столбца
EntityLogicalName String Логическое имя таблицы, содержащей столбец.
LogicalName String Логическое имя столбца.

Столбцы Yes/No (BooleanAttributeMetadata)

Да/Нет столбцов имеют следующие свойства:

Имя Тип Description
DefaultFormValue Boolean Значение по умолчанию для столбца "Да/нет".
OptionSet Object Параметры логического столбца, где каждый параметр является парой key:value.

Столбцы Choice (PicklistAttributeMetadata)

Столбцы выбора имеют это свойство:

Имя Тип Description
OptionSet Object Параметры столбца, где каждый параметр является парой key:value.

Столбцы "Выбор" (MultiSelectPicklistAttributeMetadata)

Столбцы выбора имеют следующие свойства:

Имя Тип Description
DefaultFormValue Boolean Значение по умолчанию для столбца.
OptionSet Object Параметры логического столбца, где каждый параметр является парой key:value.

Столбцы State (StateAttributeMetadata)

Столбцы состояния имеют это свойство:

Имя Тип Description
OptionSet Object Параметры столбца, где каждый параметр является парой key:value.

Столбцы состояния также имеют эти методы, которые принимают значение одного из OptionSet значений параметра в качестве arg параметра.

Имя Тип возвращаемых данных Description
getDefaultStatus(arg) Number Возвращает состояние по умолчанию (число) на основе переданного значения состояния таблицы. Сведения о состоянии и состоянии по умолчанию для таблицы см. в определениях таблиц в справочнике по таблице или сущности Dataverse.
getStatusValuesForState(arg) Массив чисел Возвращает возможные значения состояния (массив чисел) для указанного значения состояния. Сведения о значениях состояния и состояния таблицы см. в определениях таблицы в справочнике по таблицам и сущностям Dataverse.

Столбцы Status (StatusAttributeMetadata)

Столбцы состояния имеют это свойство:

Имя Тип Description
OptionSet Object Параметры столбца, где каждый параметр является парой key:value.

Столбцы состояния также имеют этот метод, который принимает значение одного из OptionSet значений параметра в качестве arg параметра.

Имя Тип возвращаемых данных Description
getState(arg) Number Возвращает значение состояния (число) для указанного значения состояния (число). Сведения о состоянии и состоянии по умолчанию для таблицы см. в определениях таблиц в справочнике по таблице или сущности Dataverse.

Xrm.Utility