Comparteix via


getEntityMetadata (API de client)

Retorna definicions de taula per a la taula especificada.

Sintaxi

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

Paràmetres

Nom Tipus Necessari Descripció
entityName String El nom lògic de la taula.
attributes Matriu de cadenes No Les columnes per obtenir definicions.
successCallback funció No Funció per cridar quan es retornen les definicions de la taula.
errorCallback funció No Una funció per cridar quan l'operació falla.

Torna

Tipus: Objecte

Descripció: Objecte que conté la informació de definicions de taula amb els valors següents.

Nom Tipus Descripció
ActivityTypeMask Nombre Si una activitat personalitzada ha d'aparèixer als menús d'activitat de l'aplicació web. 0 indica que l'activitat personalitzada no es mostra; 1 indica que apareix.
AutoRouteToOwnerQueue booleà Indica si s'han de moure automàticament els registres a la cua per defecte del propietari quan es crea o assigna un registre d'aquest tipus.
CanEnableSyncToExternalSearchIndex booleà Només per a l'ús intern.
CanTriggerWorkflow booleà Indica si la taula pot activar un procés de flux de treball.
Description String Descripció de la taula.
DisplayCollectionName String Nom de visualització plural de la taula.
DisplayName String Nom de visualització de la taula.
EnforceStateTransitions booleà Indica si la taula aplicarà transicions d'estat personalitzades.
EntityColor String El codi hexadecimal per representar el color que s'utilitzarà per a aquesta taula a l'aplicació.
EntitySetName String El nom de la taula de l'API web definida per a aquesta taula.
HasActivities booleà Indica si les activitats estan associades amb aquesta taula.
IsActivity booleà Indica si la taula és una activitat.
IsActivityParty booleà Indica si els missatges de correu electrònic es poden enviar a una adreça electrònica emmagatzemada en un registre d'aquest tipus.
IsBusinessProcessEnabled booleà Indica si la taula està habilitada per als fluxos del procés de negoci.
IsBPFEntity booleà Indica si la taula és una taula de flux del procés de negoci.
IsChildEntity booleà Indica si la taula és una taula secundària.
IsConnectionsEnabled booleà Indica si les connexions estan habilitades per a aquesta taula.
IsCustomEntity booleà Indica si la taula és una taula personalitzada.
IsCustomizable booleà Indica si la taula és personalitzable.
IsDocumentManagementEnabled booleà Indica si l'administració de documents està habilitada.
IsDocumentRecommendationsEnabled booleà Indica si les recomanacions del document estan habilitades.
IsDuplicateDetectionEnabled booleà Indica si la detecció de duplicats està activada.
IsEnabledForCharts booleà Indica si els gràfics estan habilitats.
IsImportable booleà Indica si la taula es pot importar mitjançant l'Auxiliar d'importació.
IsInteractionCentricEnabled booleà Indica que la taula està habilitada per a l'experiència interactiva.
IsKnowledgeManagementEnabled booleà Indica si l'administració del coneixement està habilitada per a la taula.
IsMailMergeEnabled booleà Indica si la combinació de correspondència està habilitada per a aquesta taula.
IsManaged booleà Indica si la taula forma part d'una solució administrada.
IsOneNoteIntegrationEnabled booleà Indica si la integració del OneNote està habilitada per a la taula.
IsOptimisticConcurrencyEnabled booleà Indica si la simultaneïtat optimista està habilitada per a la taula.
IsQuickCreateEnabled booleà Indica si la taula està habilitada per a formularis de creació ràpida.
IsStateModelAware booleà Indica si la taula admet la configuració de transicions d'estat personalitzades.
IsValidForAdvancedFind booleà Indica si la taula es mostrarà a la cerca avançada.
IsVisibleInMobileClient booleà Indica si els usuaris del Microsoft Dynamics 365 per a tauletes poden veure les dades d'aquesta taula.
IsEnabledInUnifiedInterface booleà Indica si la taula està habilitada per a la interfície unificada.
LogicalCollectionName String El nom de la col·lecció lògica.
LogicalName String El nom lògic de la taula.
ObjectTypeCode Nombre El codi del tipus de taula.
OwnershipType String El tipus de propietat de la taula: UserOwned o OrganizationOwned.
PrimaryIdAttribute String Nom de la columna que és l'identificador principal de la taula.
PrimaryImageAttribute String Nom de la columna d'imatge principal d'una taula.
PrimaryNameAttribute String Nom de la columna principal d'una taula.
Privileges Matriu d'objectes Objectes que defineixen el privilegi de seguretat per a l'accés a una taula. Vegeu l'objecte Privilege
Attributes Col·lecció Col·lecció d'objectes de definicions de columna. Vegeu Objectes d'atribut

Objecte de privilegi

Els objectes de privilegi tenen les propietats següents per definir el privilegi de seguretat per accedir a una taula:

Nom Tipus Descripció
CanBeBasic booleà Si el privilegi pot ser de nivell d'accés bàsic.
CanBeDeep booleà Si el privilegi pot ser el nivell d'accés profund.
CanBeEntityReference booleà Si el privilegi per a una part externa pot ser el nivell d'accés bàsic.
CanBeGlobal booleà Si el privilegi pot ser de nivell d'accés global.
CanBeLocal booleà Si el privilegi pot ser de nivell d'accés local.
CanBeParentEntityReference booleà Si el privilegi d'una part externa pot ser el nivell d'accés principal.
Name String El nom del privilegi.
PrivilegeId String L'identificador del privilegi.
PrivilegeType Nombre El tipus de privilegi, que és un dels següents:
0 : Cap
1 : Crear
2 : Llegir
3 : Escriu
4 : Suprimeix
5 : Assignar
6 : Comparteix
7 : Afegeix
8 : Apendi a

Objectes d'atribut

L'objecte retornat depèn del tipus de definicions de columna.

Columnes base (AttributeMetadata)

Totes les definicions de columna tenen aquestes propietats compartides:

Nom Tipus Descripció
AttributeType Nombre Tipus de columna. Per obtenir una llista dels valors de tipus de columna, vegeu Enumeració AttributeTypeCode
DisplayName String Nom de visualització de la columna
EntityLogicalName String Nom lògic de la taula que conté la columna.
LogicalName String Nom lògic de la columna.

Columnes Sí/No (BooleanAttributeMetadata)

Les columnes Sí/No tenen aquestes propietats:

Nom Tipus Descripció
DefaultFormValue booleà Valor per defecte d'una columna Sí/No.
OptionSet Objecte Opcions per a la columna booleana on cada opció és un parell clau:valor.

Columnes d'elecció (PicklistAttributeMetadata)

Les columnes d'elecció tenen aquesta propietat:

Nom Tipus Descripció
OptionSet Objecte Opcions per a la columna on cada opció és un parell clau:valor.

Columnes d'opcions (MultiSelectPicklistAttributeMetadata )

Les columnes d'opcions tenen aquestes propietats:

Nom Tipus Descripció
DefaultFormValue booleà Valor per defecte de la columna.
OptionSet Objecte Opcions per a la columna booleana on cada opció és un parell clau:valor.

Columnes d'estat (StateAttributeMetadata)

Les columnes d'estat tenen aquesta propietat:

Nom Tipus Descripció
OptionSet Objecte Opcions per a la columna on cada opció és un parell clau:valor.

Les columnes d'estat també tenen aquests mètodes que accepten el valor d'un dels valors d'opció OptionSet com a paràmetre arg .

Nom Tipus de retorn Descripció
getDefaultStatus(arg) Nombre Retorna l'estat per defecte (número) basat en el valor d'estat passat per a una taula. Per obtenir els valors d'estat i d'estat per defecte d'una taula, vegeu la informació de definicions de taula de la taula a Referència de taula/entitat del Dataverse.
getStatusValuesForState(arg) Matriu de nombres Retorna possibles valors d'estat (matriu de números) per a un valor d'estat especificat. Per obtenir els valors d'estat i d'estat d'una taula, vegeu la informació de definicions de taula de la taula a Referència de taula/entitat del Dataverse.

Columnes d'estat (StatusAttributeMetadata)

Les columnes d'estat tenen aquesta propietat:

Nom Tipus Descripció
OptionSet Objecte Opcions per a la columna on cada opció és un parell clau:valor.

Les columnes d'estat també tenen aquest mètode que accepta el valor d'un dels valors d'opció OptionSet com a paràmetre arg .

Nom Tipus de retorn Descripció
getState(arg) Nombre Retorna el valor d'estat (nombre) per al valor d'estat especificat (nombre). Per obtenir els valors d'estat i d'estat per defecte d'una taula, vegeu la informació de definicions de taula de la taula a Referència de taula/entitat del Dataverse.

Xrm.Utility