getEntityMetadata (Client API)

Devolve as definicións da táboa especificada.

Sintaxe

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

Parámetros

Nome	Tipo	Obrigatorio	Descrición
entityName	String	Si	O nome lóxico da táboa.
attributes	Matriz de cadeas	Non	As columnas para obter definicións.
successCallback	función	Non	Función para chamar cando se devolven as definicións da táboa.
errorCallback	función	Non	Unha función a chamar cando a operación falla.

Devolve

Tipo: Obxecto

Descrición: Obxecto que contén a información das definicións da táboa cos seguintes valores.

Nome	Tipo	Descrición
ActivityTypeMask	Número	Indica se debe aparecer unha actividade personalizada nos menús de actividades da aplicación web. 0 indica que a actividade personalizada non aparece; 1 indica que aparece.
AutoRouteToOwnerQueue	booleano	Indica se se deben mover automaticamente os rexistros á cola predeterminada do propietario cando se crea ou asigna un rexistro deste tipo.
CanEnableSyncToExternalSearchIndex	booleano	Só para uso interno.
CanTriggerWorkflow	booleano	Indica se a táboa pode desencadear un proceso de fluxo de traballo.
Description	String	Descrición da mesa.
DisplayCollectionName	String	Nome de visualización plural da táboa.
DisplayName	String	Mostrar o nome da táboa.
EnforceStateTransitions	booleano	Indica se a táboa aplicará transicións de estado personalizadas.
EntityColor	String	O código hexadecimal para representar a cor que se empregará para esta táboa na aplicación.
EntitySetName	String	O nome da táboa da API web establecida para esta táboa.
HasActivities	booleano	Indica se as actividades están asociadas a esta táboa.
IsActivity	booleano	Indica se a táboa é unha actividade.
IsActivityParty	booleano	Indica se as mensaxes de correo electrónico poden ser enviadas a un enderezo de correo electrónico almacenado nun rexistro deste tipo.
IsBusinessProcessEnabled	booleano	Indica se a táboa está habilitada para os fluxos de procesos de negocio.
IsBPFEntity	booleano	Indica se a táboa é unha táboa de fluxo de procesos de negocio.
IsChildEntity	booleano	Indica se a táboa é unha táboa filla.
IsConnectionsEnabled	booleano	Indica se as conexións están habilitadas para esta táboa.
IsCustomEntity	booleano	Indica se a táboa é unha táboa personalizada.
IsCustomizable	booleano	Indica se a táboa é personalizable.
IsDocumentManagementEnabled	booleano	Indica se a xestión de documentos está activada.
IsDocumentRecommendationsEnabled	booleano	Indica se as recomendacións do documento están activadas.
IsDuplicateDetectionEnabled	booleano	Indica se está activada a detección de duplicados.
IsEnabledForCharts	booleano	Indica se os gráficos están activados.
IsImportable	booleano	Indica se a táboa pode ser importada usando o asistente de importación.
IsInteractionCentricEnabled	booleano	Indica que a táboa está activada para a experiencia interactiva.
IsKnowledgeManagementEnabled	booleano	Indica se a xestión do coñecemento está habilitada para a táboa.
IsMailMergeEnabled	booleano	Indica se a combinación de correo está habilitada para esta táboa.
IsManaged	booleano	Indica se a táboa forma parte dunha solución xestionada.
IsOneNoteIntegrationEnabled	booleano	Indica se a integración de OneNote está habilitada para a táboa.
IsOptimisticConcurrencyEnabled	booleano	Indica se a simultaneidade optimista está habilitada para a táboa.
IsQuickCreateEnabled	booleano	Indica se a táboa está habilitada para a creación rápida de formularios.
IsStateModelAware	booleano	Indica se a táboa admite a configuración de transicións de estado personalizadas.
IsValidForAdvancedFind	booleano	Indica se a táboa se mostrará en Busca avanzada.
IsVisibleInMobileClient	booleano	Indica se os usuarios de Microsoft Dynamics 365 para tabletas poden ver os datos desta táboa.
IsEnabledInUnifiedInterface	booleano	Indica se a táboa está activada para a Interface unificada.
LogicalCollectionName	String	Nome da colección lóxica.
LogicalName	String	O nome lóxico da táboa.
ObjectTypeCode	Número	Código de tipo de táboa.
OwnershipType	String	O tipo de propiedade da mesa: UserOwned ou OrganizationOwned.
PrimaryIdAttribute	String	O nome da columna que é o ID principal da táboa.
PrimaryImageAttribute	String	Nome da columna da imaxe principal dunha táboa.
PrimaryNameAttribute	String	Nome da columna principal dunha táboa.
Privileges	Matriz de obxectos	Obxectos que definen o privilexio de seguridade para o acceso a unha táboa. Ver obxecto de privilexio
Attributes	Colección	Colección de obxectos de definición de columnas. Ver Obxectos de atributo

Obxecto de privilexio

Os obxectos de privilexio teñen as seguintes propiedades para definir o privilexio de seguridade para o acceso a unha táboa:

Nome	Tipo	Descrición
CanBeBasic	booleano	Se o privilexio pode ser un nivel de acceso básico.
CanBeDeep	booleano	Se o privilexio pode ser un nivel de acceso profundo.
CanBeEntityReference	booleano	Se o privilexio para unha parte externa pode ser un nivel de acceso básico.
CanBeGlobal	booleano	Se o privilexio pode ser un nivel de acceso global.
CanBeLocal	booleano	Indica se o privilexio pode ser un nivel de acceso local.
CanBeParentEntityReference	booleano	Indica se o privilexio para unha parte externa pode ser o nivel de acceso dos pais.
Name	String	O nome do privilexio.
PrivilegeId	String	Identificación do privilexio.
PrivilegeType	Número	O tipo de privilexio, que é un dos seguintes: 0 : Ningunha 1 : Crear 2 : Ler 3 : Escribir 4 : Borrar 5 : Asignar 6 : Compartir 7 : Engadir 8 : Anexar a

Atribuír obxectos

O obxecto devolto depende do tipo de definicións de columnas.

Columnas base (AttributeMetadata)

Todas as definicións de columnas teñen estas propiedades compartidas:

Nome	Tipo	Descrición
AttributeType	Número	Tipo de columna. Para unha lista de valores de tipo de columna, consulte AttributeTypeCode Enum
DisplayName	String	Nome de visualización da columna
EntityLogicalName	String	Nome lóxico da táboa que contén a columna.
LogicalName	String	Nome lóxico da columna.

Columnas Si/Non (BooleanAttributeMetadata)

As columnas Si/Non teñen estas propiedades:

Nome	Tipo	Descrición
DefaultFormValue	booleano	Valor predeterminado para unha columna Si/Non.
OptionSet	Obxecto	Opcións para a columna booleana onde cada opción é un par clave:valor.

Columnas de elección (PicklistAttributeMetadata)

As columnas de elección teñen esta propiedade:

Nome	Tipo	Descrición
OptionSet	Obxecto	Opcións para a columna onde cada opción é un par clave:valor.

Columnas de opcións (MultiSelectPicklistAttributeMetadata )

As columnas de opcións teñen estas propiedades:

Nome	Tipo	Descrición
DefaultFormValue	booleano	Valor predeterminado para a columna.
OptionSet	Obxecto	Opcións para a columna booleana onde cada opción é un par clave:valor.

Columnas de estado (StateAttributeMetadata)

As columnas de estado teñen esta propiedade:

Nome	Tipo	Descrición
OptionSet	Obxecto	Opcións para a columna onde cada opción é un par clave:valor.

As columnas de estado tamén teñen estes métodos que aceptan o valor dun dos valores da OptionSet opción como arg parámetro.

Nome	Tipo de devolución	Descrición
getDefaultStatus(arg)	Número	Devolve o estado predeterminado (número) baseado no valor de estado pasado para unha táboa. Para os valores de estado e estado predeterminados dunha táboa, consulte a información de definicións de táboa da táboa en Referencia de táboa/entidade de Dataverse.
getStatusValuesForState(arg)	Conxunto de números	Devolve posibles valores de estado (matriz de números) para un valor de estado especificado. Para os valores de estado e estado dunha táboa, consulte a información de definicións de táboa da táboa en Referencia de táboa/entidade de Dataverse.

Columnas de estado (StatusAttributeMetadata)

As columnas de estado teñen esta propiedade:

Nome	Tipo	Descrición
OptionSet	Obxecto	Opcións para a columna onde cada opción é un par clave:valor.

As columnas de estado tamén teñen este método que acepta o valor dun dos valores da OptionSet opción como arg parámetro.

Nome	Tipo de devolución	Descrición
getState(arg)	Número	Devolve o valor de estado (número) para o valor de estado especificado (número). Para os valores de estado e estado predeterminados dunha táboa, consulte a información de definicións de táboa da táboa en Referencia de táboa/entidade de Dataverse.

Artigos relacionados

Xrm.Utility