適用於 Dynamics 365 管道整合架構 1.0 的 getEntityMetadata （JavaScript API 參考）

傳回指定實體的實體中繼資料。

語法

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

參數

名稱	類型	為必填項目	Description
entityName	繩子	Yes	實體的邏輯名稱。
attributes	字串陣列	否	要取得中繼資料的屬性。

退貨

類型：物件

描述：包含具有下列屬性的實體中繼資料資訊的物件。

屬性名稱	類型	Description
活動類型遮罩	Number	自訂活動是否應該出現在 Web 應用程式的活動功能表中。 0 表示自訂活動未顯示;1 表示它確實出現。
自動路由至擁有者佇列	布林值	指出在建立或指派此類型的記錄時，是否自動將記錄移至擁有者的預設佇列。
CanEnableSyncToExternalSearchIndex	布林值	僅限內部使用。
CanTrigger工作流程	布林值	指出實體是否可以觸發工作流程程序。
Description	繩子	實體的描述。
顯示集合名稱	繩子	實體的複數顯示名稱。
顯示名稱	繩子	實體的顯示名稱。
強制執行狀態轉換	布林值	指出實體是否會強制執行自訂狀態轉換。
實體顏色	繩子	十六進位代碼，以代表要在應用程式中用於此實體的顏色。
實體集名稱	繩子	此實體的 Web API 實體集名稱。
有活動	布林值	指出活動是否與此實體相關聯。
是活動	布林值	指出實體是否為活動。
Is活動派對	布林值	指出電子郵件訊息是否可以傳送至儲存在此類型記錄中的電子郵件地址。
IsBusinessProcess已啟用	布林值	指出實體是否已啟用商務程序流程。
是BPF的實體	布林值	指出實體是否為商務程序流程實體。
IsChildEntity	布林值	指出實體是否為子實體。
IsConnections已啟用	布林值	指出是否為此實體啟用連線。
是自訂實體	布林值	指出實體是否為自訂實體。
是可自訂的	布林值	指出實體是否可自訂。
IsDocumentManagement已啟用	布林值	指出是否啟用文件管理。
IsDocumentRecommendations已啟用	布林值	指出是否已啟用文件建議。
IsDuplicateDetection已啟用	布林值	指出是否啟用重複偵測。
IsEnabledForCharts	布林值	指出是否已啟用圖表。
是不可移植的	布林值	指出是否可以使用「匯入精靈」匯入實體。
IsInteractionCentric已啟用	布林值	表示實體已啟用互動式體驗。
IsKnowledgeManagement已啟用	布林值	指出是否為實體啟用知識管理。
IsMailMerge啟用	布林值	指出是否為此實體啟用合併列印。
是受控	布林值	指出實體是否屬於受控解決方案的一部分。
IsOneNote整合已啟用	布林值	指出是否已為實體啟用 OneNote 整合。
IsOptimisticConcurrency啟用	布林值	指出是否已為實體啟用樂觀並行。
IsQuickCreate已啟用	布林值	指出實體是否已啟用快速建立表單。
IsStateModelAware	布林值	指出實體是否支援設定自訂狀態轉換。
IsValidForAdvancedFind	布林值	指出圖元是否顯示在「進階尋找」中。
IsVisibleInMobileClient	布林值	指出平板電腦版 Microsoft Dynamics 365 使用者是否可以看到此實體的資料。
IsEnabledInUnifiedInterface	布林值	指出實體是否已啟用整合介面。
邏輯集合名稱	繩子	邏輯集合名稱。
邏輯名稱	繩子	實體的邏輯名稱。
物件類型代碼	Number	實體類型代碼。
擁有權類型	繩子	實體的擁有權類型：「UserOwned」或「OrganizationOwned」。
PrimaryId屬性	繩子	屬性的名稱，該屬性是實體的主要 ID。
主要影像屬性	繩子	實體的主要影像屬性名稱。
PrimaryName屬性	繩子	實體的主要屬性名稱。
Privileges	物件陣列	實體的權限中繼資料， 其中每個 物件都包含下列屬性，以定義存取實體的安全權限： CanBeBasic：布林值。 權限是否可以是基本存取層級。 CanBeDeep：布爾值。 權限是否可以是深層存取層級。 CanBeEntityReference：布林值。 外部合作物件的權限是否可以是基本存取層級。 CanBeGlobal：布爾值。 權限是否可以是全域存取層級。 CanBeLocal：布林值。 權限是否可以是本機存取層級。 CanBeParentEntityReference：布林值。 外部合作物件的權限是否可以是父存取層級。 名稱：字串。 權限的名稱。 PrivilegeId：字串。 權限的 ID。 PrivilegeType：數字。 權限類型，為下列其中一項： 0：無 1：創建 2：閱讀 3：寫 4：刪除 5：分配 6：分享 7：附加 8：附加至
Attributes	Collection	屬性中繼資料物件的集合。 傳回的物件取決於屬性中繼資料的類型。 基底類型的屬性中繼資料 傳回具有下列屬性的物件： AttributeType：數字。 屬性的類型。 如需屬性類型值的清單，請參閱 AttributeTypeCode DisplayName：字串。 屬性的顯示名稱。 EntityLogicalName：字串。 包含屬性之實體的邏輯名稱。 LogicalName：字串。 屬性的邏輯名稱。 布林類型的屬性中繼資料 除了 基本 屬性中繼資料類型屬性之外，還具有下列屬性所傳回的物件： DefaultFormValue：布林值。 布林選項集的預設值。 OptionSet：物件。 布林屬性的選項，其中每個選項都是索引鍵：值組。 列舉類型的屬性中繼資料 除了 基本 屬性中繼資料類型屬性之外，還具有下列屬性所傳回的物件： OptionSet：物件。 屬性的選項，其中每個選項都是索引鍵：值組。 選項清單類型的屬性中繼資料 除了 基本 屬性中繼資料類型屬性之外，還具有下列屬性所傳回的物件： DefaultFormValue：數字。 屬性的預設表單值。 OptionSet：物件。 屬性的選項，其中每個選項都是索引鍵：值組。 狀態類型的屬性中繼資料 除了 基本 屬性中繼資料類型屬性之外，還具有下列屬性所傳回的物件： OptionSet：物件。 屬性的選項，其中每個選項都是索引鍵：值組。 物件也包含下列方法： getDefaultStatus（arg）：根據實體傳入的狀態值傳回預設狀態（數字）。 如需實體的預設狀態和狀態值，請參閱 實體參考中實體的實體中繼資料資訊。 getStatusValuesForState（arg）：傳回指定狀態值的可能狀態值 （數字陣列）。 如需實體的狀態和狀態值，請參閱 實體參考中實體的實體中繼資料資訊。 狀態類型的屬性中繼資料 除了 基本 屬性中繼資料類型屬性之外，還具有下列屬性所傳回的物件： OptionSet：物件。 屬性的選項，其中每個選項都是索引鍵：值組。 物件也包含下列方法： getState（arg）：傳回指定狀態值 （number） 的狀態值 （number）。 如需實體的預設狀態和狀態值，請參閱 實體參考中實體的實體中繼資料資訊。