Sdílet prostřednictvím


getEntityMetadata (Referenční dokumentace rozhraní JavaScript API) pro Dynamics 365 Channel Integration Framework 1.0

Vrátí metadata entity pro zadanou entitu.

Syntaxe

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

Parametry

Název Typ Povinné Description
entityName String Ano Logický název entity.
attributes Pole řetězců Ne Atributy, pro které se mají získat metadata.

Návraty

Typ: Objekt

Popis: Objekt obsahující informace o metadatech entity s následujícími atributy.

Název atributu Typ Description
ActivityTypeMask Number Zda se má vlastní aktivita zobrazit v nabídkách aktivit ve webové aplikaci. 0 znamená, že se vlastní aktivita nezobrazuje. 1 označuje, že se objeví.
AutoRouteToOwnerQueue logický Označuje, zda se mají záznamy automaticky přesunout do výchozí fronty vlastníka, když je vytvořen nebo přiřazen záznam tohoto typu.
CanEnableSyncToExternalSearchIndex logický Jen pro interní potřebu
Pracovní postup CanTriggerWorkflow logický Označuje, zda entita může spustit proces pracovního postupu.
Description String Popis entity.
Název_displayKolekce String Zobrazovaný název entity v množném čísle.
ZobrazovanéJméno String Zobrazovaný název subjektu.
EnforceStateTransitions logický Označuje, zda entita bude vynucovat vlastní přechody stavů.
Barva entity String Hexadecimální kód představující barvu, která má být použita pro tuto entitu v aplikaci.
EntitySetName String Název entity webového rozhraní API nastavené pro tuto entitu.
HasActivities logický Označuje, zda jsou aktivity spojeny s touto entitou.
IsActivity logický Označuje, zda je entita aktivitou.
IsActivityParty logický Označuje, zda lze e-mailové zprávy odeslat na e-mailovou adresu uloženou v záznamu tohoto typu.
IsBusinessProcessEnabled logický Označuje, zda je entita povolena pro toky obchodního procesu.
IsBPFEntity logický Označuje, zda je entita entitou toku obchodního procesu.
Entita IsChildEntity logický Označuje, zda je entita podřízenou entitou.
IsConnectionsEnabled logický Označuje, zda jsou pro tuto entitu povolena připojení.
IsCustomEntity logický Označuje, zda je entita vlastní entitou.
Je přizpůsobitelný logický Označuje, zda je entita přizpůsobitelná.
IsDocumentManagementEnabled logický Označuje, zda je povolena správa dokumentů.
IsDocumentRecommendationsEnabled logický Označuje, zda jsou povolena doporučení pro dokumenty.
IsDuplicateDetectionEnabled logický Označuje, zda je povoleno vyhledávání duplicit.
IsEnabledForCharts logický Označuje, zda jsou povoleny grafy.
Je možné importovat logický Označuje, zda lze entitu importovat pomocí Průvodce importem.
IsInteractionCentricEnabled logický Označuje, že entita je povolena pro interaktivní prostředí.
IsKnowledgeManagementEnabled logický Označuje, zda je pro danou entitu povolena správa znalostí.
IsMailMergeEnabled logický Označuje, zda je pro tuto entitu povolena hromadná korespondence.
IsManaged logický Označuje, zda je entita součástí spravovaného řešení.
IsOneNoteIntegrationEnabled logický Označuje, zda je pro entitu povolena integrace aplikace OneNote.
IsOptimisticConcurrencyEnabled logický Označuje, zda je pro entitu povolena optimistická souběžnost.
IsQuickCreateEnabled logický Označuje, zda je entita povolena pro rychlé vytváření formulářů.
IsStateModelAware logický Označuje, zda entita podporuje nastavení vlastních přechodů stavů.
IsValidForAdvancedFind logický Označuje, zda je entita zobrazena v rozšířeném hledání.
IsVisibleInMobileClient logický Označuje, zda uživatelé aplikace Microsoft Dynamics 365 pro tablety mohou zobrazit data pro tuto entitu.
IsEnabledInUnifiedInterface logický Označuje, zda je entita povolena pro Sjednocené rozhraní.
Název_logické kolekce String Logický název kolekce.
Logický název String Logický název entity.
ObjectTypeCode Number Kód typu entity.
Typ vlastnictví String Typ vlastnictví entity: "UserOwned" nebo "OrganizationOwned".
PrimaryIdAttribute String Název atributu, který je primárním ID entity.
PrimaryImageAttribute String Název primárního atributu obrazu pro entitu.
Atribut primárního názvu String Název primárního atributu pro entitu.
Privilegia Pole objektů Metadata oprávnění pro entitu, kde každý objekt obsahuje následující atributy pro definování oprávnění zabezpečení pro přístup k entitě:
  • CanBeBasic: Booleovská hodnota. Zda může být oprávnění základní úrovní přístupu.
  • CanBeDeep: Booleovská. Zda může být oprávnění na úrovni hlubokého přístupu.
  • CanBeEntityReference: Logická hodnota. Zda může být oprávnění pro externí stranu základní úrovní přístupu.
  • CanBeGlobal: Booleovské. Zda může být oprávnění na globální úrovni přístupu.
  • CanBeLocal: Booleovská hodnota. Zda může být oprávnění na místní úrovni přístupu.
  • CanBeParentEntityReference: Logická hodnota. Zda může být oprávnění pro externí stranu nadřazenou úrovní přístupu.
  • Název: Řetězec. Název oprávnění.
  • PrivilegeId: Řetězec. ID oprávnění.
  • PrivilegeType: Číslo. Typ oprávnění, který je jedním z následujících:
    • 0: Žádné
    • 1: Vytvořit
    • 2: Přečtěte si
    • 3: Napište
    • 4: Odstranit
    • 5: Přiřadit
    • 6: Sdílet
    • 7: Připojit
    • 8: Připojit k
Attributes Collection Kolekce objektů metadat atributů. Vrácený objekt závisí na typu metadat atributu.

Metadata atributu pro základní typ
Vrácený objekt s následujícími vlastnostmi:

  • AttributeType: Číslo. Typ atributu. Seznam hodnot typu atributu naleznete v tématu AttributeTypeCode.
  • DisplayName: Řetězec. Zobrazovaný název atributu.
  • EntityLogicalName: Řetězec. Logický název entity, která obsahuje atribut.
  • LogicalName: Řetězec. Logický název atributu.

Metadata atributu pro booleovský typ
Objekt vrácený s následujícími vlastnostmi navíc k vlastnostem typu metadat základního atributu:

  • DefaultFormValue: Logická hodnota. Výchozí hodnota pro logickou sadu možností.
  • OptionSet: Objekt. Možnosti pro logický atribut, kde každá možnost je dvojicí klíč:hodnota.

Metadata atributu pro typ výčtu
Objekt vrácený s následujícími vlastnostmi navíc k vlastnostem typu metadat základního atributu:

  • OptionSet: Objekt. Možnosti pro atribut, kde každá možnost je dvojicí klíč:hodnota.

Metadata atributů pro typ rozevíracího seznamu
Objekt vrácený s následujícími vlastnostmi navíc k vlastnostem typu metadat základního atributu:

  • DefaultFormValue: Číslo. Výchozí hodnota formuláře pro atribut.
  • OptionSet: Objekt. Možnosti pro atribut, kde každá možnost je dvojicí klíč:hodnota.

Metadata atributu pro typ stavu
Objekt vrácený s následujícími vlastnostmi navíc k vlastnostem typu metadat základního atributu:

  • OptionSet: Objekt. Možnosti pro atribut, kde každá možnost je dvojicí klíč:hodnota.

Objekt obsahuje také následující metody:

  • getDefaultStatus(arg): Vrátí výchozí stav (číslo) na základě hodnoty předaného stavu pro entitu. Informace o výchozím stavu a stavu entity naleznete v části Informace o metadatech entity v Referenční informace k entitě.
  • getStatusValuesForState(arg): Vrací možné stavové hodnoty (pole čísel) pro zadanou hodnotu stavu. Hodnoty stavu a stavu entity naleznete v části Informace o metadatech entity v Odkazu na entitu.

Metadata atributu pro typ stavu
Objekt vrácený s následujícími vlastnostmi navíc k vlastnostem typu metadat základního atributu:

  • OptionSet: Objekt. Možnosti pro atribut, kde každá možnost je dvojicí klíč:hodnota.

Objekt obsahuje také následující metodu:

  • getState(arg): Vrací hodnotu stavu (číslo) pro zadanou stavovou hodnotu (číslo). Informace o výchozím stavu a stavu entity naleznete v části Informace o metadatech entity v Referenční informace k entitě.