Udostępnij przez


getEntityMetadata (interfejs API klienta)

Zwraca definicje tabeli dla określonej tabeli.

Składnia

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

Parametry

Name Typ Wymagane Description
entityName Sznurek Tak Logiczna nazwa tabeli.
attributes Tablica ciągów znaków Nie. Kolumny, dla których mają być uzyskiwane definicje.
successCallback funkcja Nie. Funkcja, która ma być wywoływana, gdy są zwracane definicje tabeli.
errorCallback funkcja Nie. Funkcja wywoływana, gdy operacja zakończy się niepowodzeniem.

Zwraca

Typ: Obiekt

Opis: Obiekt zawierający informacje o definicjach tabeli z następującymi wartościami.

Name Typ Description
ActivityTypeMask Number Określa, czy działanie niestandardowe powinno być wyświetlane w menu działań w aplikacji internetowej. 0 wskazuje, że działanie niestandardowe nie jest wyświetlane; 1 wskazuje, że jest wyświetlany.
AutoRouteToOwnerQueue logiczny Wskazuje, czy rekordy mają być automatycznie przenoszone do domyślnej kolejki właściciela po utworzeniu lub przypisaniu rekordu tego typu.
CanEnableSyncToExternalSearchIndex logiczny Tylko do użytku wewnętrznego.
CanTriggerWorkflow logiczny Wskazuje, czy tabela może wyzwolić proces przepływu pracy.
Description Sznurek Opis tabeli.
DisplayCollectionName Sznurek Nazwa wyświetlana w liczbie mnogiej dla tabeli.
DisplayName Sznurek Nazwa wyświetlana tabeli.
EnforceStateTransitions logiczny Wskazuje, czy tabela będzie wymuszać niestandardowe przejścia stanu.
EntityColor Sznurek Kod szesnastkowy reprezentujący kolor używany dla tej tabeli w aplikacji.
EntitySetName Sznurek Nazwa tabeli internetowego interfejsu API ustawiona dla tej tabeli.
HasActivities logiczny Wskazuje, czy działania są skojarzone z tą tabelą.
IsActivity logiczny Wskazuje, czy tabela jest działaniem.
IsActivityParty logiczny Wskazuje, czy wiadomości e-mail mogą być wysyłane na adres e-mail przechowywany w rekordzie tego typu.
IsBusinessProcessEnabled logiczny Wskazuje, czy tabela jest włączona dla przepływów procesów biznesowych.
IsBPFEntity logiczny Wskazuje, czy tabela jest tabelą przepływu procesów biznesowych.
IsChildEntity logiczny Wskazuje, czy tabela jest tabelą podrzędną.
IsConnectionsEnabled logiczny Wskazuje, czy połączenia są włączone dla tej tabeli.
IsCustomEntity logiczny Wskazuje, czy tabela jest tabelą niestandardową.
IsCustomizable logiczny Wskazuje, czy tabela jest dostosowywalna.
IsDocumentManagementEnabled logiczny Wskazuje, czy zarządzanie dokumentami jest włączone.
IsDocumentRecommendationsEnabled logiczny Wskazuje, czy zalecenia dotyczące dokumentu są włączone.
IsDuplicateDetectionEnabled logiczny Wskazuje, czy jest włączone wykrywanie duplikatów.
IsEnabledForCharts logiczny Wskazuje, czy wykresy są włączone.
IsImportable logiczny Wskazuje, czy tabelę można zaimportować przy użyciu Kreatora importu.
IsInteractionCentricEnabled logiczny Wskazuje, że tabela jest włączona dla środowiska interaktywnego.
IsKnowledgeManagementEnabled logiczny Wskazuje, czy zarządzanie wiedzą jest włączone dla tabeli.
IsMailMergeEnabled logiczny Wskazuje, czy korespondencja seryjna jest włączona dla tej tabeli.
IsManaged logiczny Wskazuje, czy tabela jest częścią rozwiązania zarządzanego.
IsOneNoteIntegrationEnabled logiczny Wskazuje, czy integracja programu OneNote jest włączona dla tabeli.
IsOptimisticConcurrencyEnabled logiczny Wskazuje, czy dla tabeli jest włączona optymistyczna współbieżność.
IsQuickCreateEnabled logiczny Wskazuje, czy tabela jest włączona dla formularzy szybkiego tworzenia.
IsStateModelAware logiczny Wskazuje, czy tabela obsługuje ustawianie niestandardowych przejść stanu.
IsValidForAdvancedFind logiczny Wskazuje, czy tabela zostanie wyświetlona w wyszukiwaniu zaawansowanym.
IsVisibleInMobileClient logiczny Wskazuje, czy użytkownicy usługi Microsoft Dynamics 365 dla tabletów mogą wyświetlać dane dla tej tabeli.
IsEnabledInUnifiedInterface logiczny Wskazuje, czy tabela jest włączona dla ujednoliconego interfejsu.
LogicalCollectionName Sznurek Nazwa kolekcji logicznej.
LogicalName Sznurek Nazwa logiczna tabeli.
ObjectTypeCode Number Kod typu tabeli.
OwnershipType Sznurek Typ własności tabeli: UserOwned lub OrganizationOwned.
PrimaryIdAttribute Sznurek Nazwa kolumny, która jest identyfikatorem podstawowym tabeli.
PrimaryImageAttribute Sznurek Nazwa kolumny obrazu podstawowego dla tabeli.
PrimaryNameAttribute Sznurek Nazwa kolumny podstawowej tabeli.
Privileges Tablica obiektów Obiekty definiujące uprawnienia zabezpieczeń w celu uzyskania dostępu do tabeli. Zobacz Obiekt Privilege
Attributes Kolekcja Kolekcja obiektów definicji kolumn. Zobacz Obiekty atrybutów

Obiekt privilege

Obiekty uprzywilejowane mają następujące właściwości, aby zdefiniować uprawnienia zabezpieczeń w celu uzyskania dostępu do tabeli:

Name Typ Description
CanBeBasic logiczny Określa, czy uprawnienie może być podstawowym poziomem dostępu.
CanBeDeep logiczny Czy uprawnienie może być na poziomie głębokiego dostępu.
CanBeEntityReference logiczny Określa, czy uprawnienie dla podmiotu zewnętrznego może być podstawowym poziomem dostępu.
CanBeGlobal logiczny Określa, czy uprawnienie może być globalnym poziomem dostępu.
CanBeLocal logiczny Określa, czy uprawnienie może być na poziomie dostępu lokalnego.
CanBeParentEntityReference logiczny Określa, czy uprawnienie dla strony zewnętrznej może być na poziomie dostępu nadrzędnego.
Name Sznurek Nazwa uprawnień.
PrivilegeId Sznurek Identyfikator uprawnienia.
PrivilegeType Number Typ uprawnienia, który jest jednym z następujących:
0: Brak
1: Tworzenie
2: Odczyt
3: Zapis
4: Usuwanie
5: Przypisywanie
6: Udostępnianie
7: Dołączanie
8: AppendTo

Obiekty atrybutów

Zwrócony obiekt zależy od typu definicji kolumn.

Kolumny base (AttributeMetadata)

Wszystkie definicje kolumn mają następujące właściwości udostępnione:

Name Typ Description
AttributeType Number Typ kolumny. Aby uzyskać listę wartości typu kolumny, zobacz AttributeTypeCode Enum (Wyliczenie AtrybutTypeCode)
DisplayName Sznurek Nazwa wyświetlana kolumny
EntityLogicalName Sznurek Logiczna nazwa tabeli zawierającej kolumnę.
LogicalName Sznurek Nazwa logiczna kolumny.

Tak/Nie (kolumny BooleanAttributeMetadata)

Kolumny Tak/Nie mają następujących właściwości:

Name Typ Description
DefaultFormValue logiczny Wartość domyślna dla kolumny Tak/Nie.
OptionSet Object Opcje kolumny logicznej, w której każda opcja jest parą klucz:wartość.

Wybór (kolumny PicklistAttributeMetadata)

Kolumny wyboru mają tę właściwość:

Name Typ Description
OptionSet Object Opcje kolumny, w której każda opcja jest parą key:value.

Choices (Kolumny MultiSelectPicklistAttributeMetadata )

Kolumny wyboru mają następujące właściwości:

Name Typ Description
DefaultFormValue logiczny Wartość domyślna kolumny.
OptionSet Object Opcje kolumny logicznej, w której każda opcja jest parą klucz:wartość.

Kolumny StateAttributeMetadata

Kolumny stanu mają tę właściwość:

Name Typ Description
OptionSet Object Opcje kolumny, w której każda opcja jest parą key:value.

Kolumny stanu mają również te metody, które akceptują wartość jednej z OptionSet wartości opcji jako parametru arg .

Name Zwracany typ Description
getDefaultStatus(arg) Number Zwraca domyślny stan (liczba) na podstawie przekazanej wartości stanu dla tabeli. Aby uzyskać informacje o domyślnym stanie i stanie tabeli, zobacz informacje o definicjach tabeli w dokumentacji tabeli/jednostki usługi Dataverse.
getStatusValuesForState(arg) Tablica liczb Zwraca możliwe wartości stanu (tablica liczb) dla określonej wartości stanu. Aby uzyskać informacje o wartościach stanu i stanu tabeli, zobacz informacje o definicjach tabeli w dokumentacji tabeli/jednostki usługi Dataverse.

Kolumny StatusAttributeMetadata

Kolumny stanu mają tę właściwość:

Name Typ Description
OptionSet Object Opcje kolumny, w której każda opcja jest parą key:value.

Kolumny stanu mają również tę metodę, która akceptuje wartość jednej z OptionSet wartości opcji jako parametru arg .

Name Zwracany typ Description
getState(arg) Number Zwraca wartość stanu (liczbę) dla określonej wartości stanu (liczba). Aby uzyskać informacje o domyślnym stanie i stanie tabeli, zobacz informacje o definicjach tabeli w dokumentacji tabeli/jednostki usługi Dataverse.

Xrm.Utility