傳回指定資料表的資料表定義。
語法
Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)
參數
| 名稱 | 類型 | 為必填項目 | Description |
|---|---|---|---|
entityName |
繩子 | Yes | 資料表的邏輯名稱。 |
attributes |
字串陣列 | 否 | 要取得其定義的資料行。 |
successCallback |
函式 | 否 | 傳回資料表定義時要呼叫的函式。 |
errorCallback |
函式 | 否 | 作業失敗時要呼叫的函式。 |
退貨
類型：物件
說明：包含具有下列值的表格定義資訊的物件。
| 名稱 | 類型 | Description |
|---|---|---|
ActivityTypeMask |
Number | 自訂活動是否應該出現在 Web 應用程式的活動功能表中。
0 表示自訂活動未顯示; 1 表示它確實出現了。 |
AutoRouteToOwnerQueue |
布林值 | 指出在建立或指派此類型的記錄時，是否自動將記錄移至擁有者的預設佇列。 |
CanEnableSyncToExternalSearchIndex |
布林值 | 僅限內部使用。 |
CanTriggerWorkflow |
布林值 | 指出表格是否可以觸發工作流程程序。 |
Description |
繩子 | 表格的描述。 |
DisplayCollectionName |
繩子 | 表格的複數顯示名稱。 |
DisplayName |
繩子 | 表格的顯示名稱。 |
EnforceStateTransitions |
布林值 | 指出資料表是否會強制執行自訂狀態轉換。 |
EntityColor |
繩子 | 十六進位代碼，以代表要在應用程式中用於此表格的顏色。 |
EntitySetName |
繩子 | 為此資料表設定的 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 使用者是否可以看到此資料表的資料。 |
IsEnabledInUnifiedInterface |
布林值 | 指出資料表是否已啟用整合介面。 |
LogicalCollectionName |
繩子 | 邏輯集合名稱。 |
LogicalName |
繩子 | 資料表的邏輯名稱。 |
ObjectTypeCode |
Number | 表格類型代碼。 |
OwnershipType |
繩子 | 表格的擁有權類型： UserOwned 或 OrganizationOwned。 |
PrimaryIdAttribute |
繩子 | 資料表主要 ID 的資料行名稱。 |
PrimaryImageAttribute |
繩子 | 表格的主要影像欄的名稱。 |
PrimaryNameAttribute |
繩子 | 資料表的主要資料行名稱。 |
Privileges |
物件陣列 | 定義存取表格之安全權限的物件。 請參閱 Privilege 物件 |
Attributes |
Collection | 資料行定義物件的集合。 請參閱 屬性物件 |
權限物件
權限物件具有下列內容，可定義存取表格的安全權限：
| 名稱 | 類型 | Description |
|---|---|---|
CanBeBasic |
布林值 | 權限是否可以是基本存取層級。 |
CanBeDeep |
布林值 | 權限是否可以是深層存取層級。 |
CanBeEntityReference |
布林值 | 外部合作物件的權限是否可以是基本存取層級。 |
CanBeGlobal |
布林值 | 權限是否可以是全域存取層級。 |
CanBeLocal |
布林值 | 權限是否可以是本機存取層級。 |
CanBeParentEntityReference |
布林值 | 外部合作物件的權限是否可以是父存取層級。 |
Name |
繩子 | 許可權的名稱。 |
PrivilegeId |
繩子 | 權限的 ID。 |
PrivilegeType |
Number | 權限類型，為下列其中一項： 0 ： 無 1 ： 創建 2 ： 閱讀 3 ： 寫入 4 ： 刪除 5 ： 分配 6 ： 分享 7 ： 附加 8 ： 附加至 |
屬性物件
傳回的物件取決於資料行定義的類型。
基底 （AttributeMetadata） 資料行
所有資料行定義都有下列共用屬性：
| 名稱 | 類型 | Description |
|---|---|---|
AttributeType |
Number | 資料行的類型。 如需資料行類型值的清單，請參閱 AttributeTypeCode 列舉 |
DisplayName |
繩子 | 資料行的顯示名稱 |
EntityLogicalName |
繩子 | 包含資料行之資料表的邏輯名稱。 |
LogicalName |
繩子 | 資料行的邏輯名稱。 |
是/否 （BooleanAttributeMetadata） 資料行
是/否資料行具有下列屬性：
| 名稱 | 類型 | Description |
|---|---|---|
DefaultFormValue |
布林值 | 是/否欄的預設值。 |
OptionSet |
物體 | 布林值資料行的選項，其中每個選項都是索引鍵：值組。 |
選擇 （PicklistAttributeMetadata） 欄
選擇欄具有以下屬性：
| 名稱 | 類型 | Description |
|---|---|---|
OptionSet |
物體 | 每個選項都是索引鍵：值組的欄的選項。 |
Choices （MultiSelectPicklistAttributeMetadata ） 資料行
選擇欄具有下列屬性：
| 名稱 | 類型 | Description |
|---|---|---|
DefaultFormValue |
布林值 | 資料行的預設值。 |
OptionSet |
物體 | 布林值資料行的選項，其中每個選項都是索引鍵：值組。 |
State （StateAttributeMetadata） 資料行
狀態資料行具有下列屬性：
| 名稱 | 類型 | Description |
|---|---|---|
OptionSet |
物體 | 每個選項都是索引鍵：值組的欄的選項。 |
狀態資料行也有這些方法，這些方法接受其中一個 OptionSet 選項值的值作為 arg 參數。
| 名稱 | 返回類型 | Description |
|---|---|---|
getDefaultStatus(arg) |
Number | 根據資料表的傳入狀態值傳回預設狀態 （數字）。 如需資料表的預設狀態和狀態值，請參閱 Dataverse 資料表/實體參考中資料表的資料表定義資訊。 |
getStatusValuesForState(arg) |
數字陣列 | 傳回指定狀態值的可能狀態值 （數字陣列）。 如需資料表的狀態和狀態值，請參閱 Dataverse 資料表/實體參考中資料表的資料表定義資訊。 |
狀態 （StatusAttributeMetadata） 資料行
狀態資料行具有下列屬性：
| 名稱 | 類型 | Description |
|---|---|---|
OptionSet |
物體 | 每個選項都是索引鍵：值組的欄的選項。 |
狀態直欄也有這個方法，它接受其中一個 OptionSet 選項值的值作為 arg 參數。
| 名稱 | 返回類型 | Description |
|---|---|---|
getState(arg) |
Number | 傳回指定狀態值 （數字） 的狀態值 （數字）。 如需資料表的預設狀態和狀態值，請參閱 Dataverse 資料表/實體參考中資料表的資料表定義資訊。 |