getEntityMetadata (API клієнта)

Повертає визначення таблиці для вказаної таблиці.

Синтаксис

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

Параметри

Ім'я	Тип	Необхідний	Опис
entityName	String	Так	Логічне ім'я таблиці.
attributes	Масив рядків	Ні	Стовпці для отримання визначень.
successCallback	функція	Ні	Функція, яка викликається, коли повертаються визначення таблиці.
errorCallback	функція	Ні	Функція для виклику, коли операція не вдається.

Повертає

Тип: Об'єкт

Опис: об'єкт, що містить відомості про визначення таблиці з такими значеннями.

Ім'я	Тип	Опис
ActivityTypeMask	Число	Чи має користувацька активність відображатися в меню дій у веб-програмі. 0 вказує на те, що настроювана дія не відображається; 1 вказує на те, що він з'являється.
AutoRouteToOwnerQueue	логічний	Указує, чи слід автоматично переміщувати записи до стандартної черги власника, коли створюється або призначається запис цього типу.
CanEnableSyncToExternalSearchIndex	логічний	Лише для внутрішнього використання.
CanTriggerWorkflow	логічний	Указує, чи може таблиця ініціювати процес робочого циклу.
Description	String	Опис таблиці.
DisplayCollectionName	String	Коротке ім'я множини для таблиці.
DisplayName	String	Коротке ім'я таблиці.
EnforceStateTransitions	логічний	Указує, чи буде таблиця застосовувати переходи настроюваного стану.
EntityColor	String	Шістнадцятковий код, який позначає колір, який використовуватиметься для цієї таблиці в програмі.
EntitySetName	String	Ім'я таблиці 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 для планшетів переглядати дані цієї таблиці.
IsEnabledInUnifiedInterface	логічний	Указує, чи ввімкнуто таблицю для уніфікованого інтерфейсу.
LogicalCollectionName	String	Логічна назва колекції.
LogicalName	String	Логічне ім'я таблиці.
ObjectTypeCode	Число	Код типу таблиці.
OwnershipType	String	Тип права власності для таблиці: UserOwned або OrganizationOwned.
PrimaryIdAttribute	String	Ім'я стовпця, який є основним ідентифікатором таблиці.
PrimaryImageAttribute	String	Ім'я основного стовпця зображення для таблиці.
PrimaryNameAttribute	String	Ім'я основного стовпця таблиці.
Privileges	Масив об'єктів	Об'єкти, які визначають право безпеки для доступу до таблиці. Див . об'єкт Privilege
Attributes	Колекція	Колекція об'єктів визначення стовпців. Див . об'єкти атрибутів

Об'єкт Privilege

Об'єкти прав мають такі властивості, щоб визначити права безпеки для доступу до таблиці:

Ім'я	Тип	Опис
CanBeBasic	логічний	Чи може привілей бути базовим рівнем доступу.
CanBeDeep	логічний	Чи може привілей бути рівнем глибокого доступу.
CanBeEntityReference	логічний	Чи може привілей для зовнішньої сторони бути базовим рівнем доступу.
CanBeGlobal	логічний	Чи може привілей бути глобальним рівнем доступу.
CanBeLocal	логічний	Чи може привілей бути локальним рівнем доступу.
CanBeParentEntityReference	логічний	Чи може привілей для зовнішньої сторони бути батьківським рівнем доступу.
Name	String	Назва привілею.
PrivilegeId	String	Ідентифікатор привілею.
PrivilegeType	Число	Тип привілею, який є одним із наступних: 0 : Немає 1: Створення 2 : Читання 3: Записування 4: Видалення 5: Призначення 6: Спільний доступ 7: Додавання 8: Додавання

Об'єкти атрибутів

Об'єкт, що повертається, залежить від типу визначень стовпців.

Стовпці base (AttributeMetadata)

Усі визначення стовпців мають такі спільні властивості:

Ім'я	Тип	Опис
AttributeType	Число	Тип стовпця. Список значень типу стовпця див . в статті Enum AttributeTypeCode
DisplayName	String	Коротке ім'я стовпця
EntityLogicalName	String	Логічне ім'я таблиці, яка містить стовпець.
LogicalName	String	Логічне ім'я стовпця.

Стовпці Yes/No (BooleanAttributeMetadata)

Стовпці "Так/Ні" мають такі властивості:

Ім'я	Тип	Опис
DefaultFormValue	логічний	Значення за промовчанням для стовпця "Так/Ні".
OptionSet	Об'єкт	Параметри для логічного стовпця, у якому кожен параметр – це пара key:value.

Стовпці Choice (PicklistAttributeMetadata)

Вибір стовпців має таку властивість:

Ім'я	Тип	Опис
OptionSet	Об'єкт	Параметри стовпця, у якому кожен параметр – це пара key:value.

Choices (MultiSelectPicklistAttributeMetadata ) columns

Стовпці вибору мають такі властивості:

Ім'я	Тип	Опис
DefaultFormValue	логічний	Стандартне значення стовпця.
OptionSet	Об'єкт	Параметри для логічного стовпця, у якому кожен параметр – це пара key:value.

Стовпці state (StateAttributeMetadata)

Стовпці стану мають таку властивість:

Ім'я	Тип	Опис
OptionSet	Об'єкт	Параметри стовпця, у якому кожен параметр – це пара key:value.

Стовпці стану також мають ці методи, які приймають значення одного зі OptionSet значень параметра як arg параметр.

Ім'я	Тип повернення	Опис
getDefaultStatus(arg)	Число	Повертає стан за промовчанням (число) на основі переданого значення стану таблиці. Відомості про стан і стани таблиці за промовчанням див. в статті Відомості про визначення таблиці в таблиці Dataverse таблиці або посиланні на сутність.
getStatusValuesForState(arg)	Масив чисел	Повертає можливі значення стану (масив чисел) для вказаного значення стану. Відомості про стан і значення стану таблиці див. в статті Відомості про визначення таблиці в таблиці Dataverse таблиці або посилання на сутність.

Стовпці status (StatusAttributeMetadata)

Стовпці стану мають таку властивість:

Ім'я	Тип	Опис
OptionSet	Об'єкт	Параметри стовпця, у якому кожен параметр – це пара key:value.

Стовпці стану також мають цей метод, який приймає значення одного зі OptionSet значень параметра як arg параметр.

Ім'я	Тип повернення	Опис
getState(arg)	Число	Повертає значення стану (число) для вказаного значення стану (числа). Відомості про стан і стани таблиці за промовчанням див. в статті Відомості про визначення таблиці в таблиці Dataverse таблиці або посиланні на сутність.

Пов’язані статті

Xrm.Utility