getEntityMetadata (API de cliente)
Devuelve las definiciones de tabla para la tabla especificada.
Sintaxis
Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)
Parámetros
| Nombre. | Type | Obligatorio | Description |
|---|---|---|---|
entityName |
String | Sí | Nombre lógico de la tabla. |
attributes |
Matriz de cadenas | No | Las columnas para las que se obtienen las definiciones. |
successCallback |
function | No | Una función para llamar cuando se devuelven las definiciones de la tabla. |
errorCallback |
function | No | Una función a la que se llama cuando la operación tiene error. |
Devoluciones
Tipo: Objeto
Descripción: un objeto que contiene la información de las definiciones de la tabla con los siguientes valores.
| Name | Type | Description |
|---|---|---|
ActivityTypeMask |
Number | Si una actividad personalizada debe aparecer en los menús de la actividad en la aplicación web. 0 indica que la actividad personalizada no aparece; 1 indica que aparece. |
AutoRouteToOwnerQueue |
Booleana | Indica si mover los registros de forma automática a la cola predeterminada del propietario cuando se cree o asigne un registro de este tipo. |
CanEnableSyncToExternalSearchIndex |
Booleana | Para uso interno. |
CanTriggerWorkflow |
Booleana | Indica si la tabla puede desencadenar un proceso de flujo de trabajo. |
Description |
String | Descripción de la tabla. |
DisplayCollectionName |
String | Nombre para mostrar en plural de la tabla. |
DisplayName |
String | Nombre para mostrar para la tabla. |
EnforceStateTransitions |
Booleana | Indica si la tabla aplicará transiciones de estado personalizadas. |
EntityColor |
String | El código hexadecimal para representar el color que se utilizará para esta tabla en la aplicación. |
EntitySetName |
String | El nombre de la tabla de API web establecida para esta tabla. |
HasActivities |
Booleana | Indica si las actividades están asociadas con esta tabla. |
IsActivity |
Booleana | Indica si la tabla es una actividad. |
IsActivityParty |
Booleana | Indica si los correos electrónicos se pueden enviar a una dirección de correo electrónico almacenada en un registro de este tipo. |
IsBusinessProcessEnabled |
Booleana | Indica si la tabla está habilitada para los flujos de procesos de negocio. |
IsBPFEntity |
Booleana | Indica si la tabla es una tabla de flujos de procesos de negocio. |
IsChildEntity |
Booleana | Indica si la tabla es una tabla secundaria. |
IsConnectionsEnabled |
Booleana | Indica si las conexiones están habilitadas para esta tabla. |
IsCustomEntity |
Booleana | Indica si la tabla es una tabla personalizada. |
IsCustomizable |
Booleana | Indica si la tabla es una tabla que se puede personalizar. |
IsDocumentManagementEnabled |
Booleana | Indica si está habilitada la administración de documentos. |
IsDocumentRecommendationsEnabled |
Booleana | Indica si las recomendaciones de documentos están habilitadas. |
IsDuplicateDetectionEnabled |
Booleana | Indica si la detección de duplicados está habilitada. |
IsEnabledForCharts |
Booleana | Indica si los gráficos están habilitados. |
IsImportable |
Booleana | Indica si la tabla se puede importar mediante el asistente para importación. |
IsInteractionCentricEnabled |
Booleana | Indica si la tabla está habilitada para la experiencia interactiva. |
IsKnowledgeManagementEnabled |
Booleana | Indica si la administración del conocimiento está habilitada para la tabla. |
IsMailMergeEnabled |
Booleana | Indica si las combinar correspondencia está habilitada para esta tabla. |
IsManaged |
Booleana | Indica si la tabla forma parte de una solución administrada. |
IsOneNoteIntegrationEnabled |
Booleana | Indica si la integración de OneNote está habilitada para la tabla. |
IsOptimisticConcurrencyEnabled |
Booleana | Indica si la simultaneidad optimista está habilitada para la tabla. |
IsQuickCreateEnabled |
Booleana | Indica si la tabla está habilitada para formularios de creación rápida. |
IsStateModelAware |
Booleana | Indica si la tabla admite establecer transiciones de estado personalizadas. |
IsValidForAdvancedFind |
Booleana | Indica si la tabla se mostrará en Búsqueda avanzada. |
IsVisibleInMobileClient |
Booleana | Indica si Microsoft Dynamics 365 para usuarios de tabletas puede ver los datos de esta tabla. |
IsEnabledInUnifiedInterface |
Booleana | Indica si la tabla del conocimiento está habilitada para la interfaz unificada. |
LogicalCollectionName |
String | El nombre lógico de la colección. |
LogicalName |
String | Nombre lógico para la tabla. |
ObjectTypeCode |
Number | El código de tipo de tabla. |
OwnershipType |
String | El tipo de propiedad para la tabla: UserOwned o OrganizationOwned. |
PrimaryIdAttribute |
String | El nombre de la columna que es el identificador principal de la tabla. |
PrimaryImageAttribute |
String | El nombre de la columna de la imagen principal para la tabla. |
PrimaryNameAttribute |
String | El nombre de la columna principal para la tabla. |
Privileges |
Matriz de objetos | Objetos que definen el privilegio de seguridad para acceder a una tabla. Ver Objeto de privilegio |
Attributes |
Colección | Una colección de objetos de definiciones de columna. Ver Objetos de atributos |
Ver Objeto de privilegio
Los objetos de privilegio tienen las siguientes propiedades para definir el privilegio de seguridad para acceder a una tabla:
| Name | Type | Description |
|---|---|---|
CanBeBasic |
Booleana | Si el privilegio puede ser un nivel de acceso básico. |
CanBeDeep |
Booleana | Si el privilegio puede ser un nivel de acceso exhaustivo. |
CanBeEntityReference |
Booleana | Si el privilegio para una parte externa puede ser un nivel de acceso básico. |
CanBeGlobal |
Booleana | Si el privilegio puede ser un nivel de acceso global. |
CanBeLocal |
Booleana | Si el privilegio puede ser un nivel de acceso local. |
CanBeParentEntityReference |
Booleana | Si el privilegio para una parte externa puede ser un nivel de acceso principal. |
Name |
String | El nombre del privilegio. |
PrivilegeId |
String | El identificador del privilegio. |
PrivilegeType |
Number | El tipo de privilegio, que es una de las alternativas siguientes: 0: Ninguno 1: Crear 2: Leer 3: Escribir 4: Eliminar 5: Asignar 6: Compartir 7: Anexar 8: AppendTo |
Ver Objetos de atributos
El objeto devuelto depende del tipo de definiciones de columna.
Columnas base (AttributeMetadata)
Todas las definiciones de columnas tienen estas propiedades compartidas:
| Name | Type | Description |
|---|---|---|
AttributeType |
Number | Tipo de una columna. Para obtener una lista de valores de tipo de columna, consulte enumeración AttributeTypeCode |
DisplayName |
String | Nombre para mostrar de la columna |
EntityLogicalName |
String | Nombre lógico de la tabla que contiene la columna. |
LogicalName |
String | Nombre lógico de la columna. |
Columnas Sí/No (BooleanAttributeMetadata)
Las columnas Sí/No tienen estas propiedades:
| Name | Type | Description |
|---|---|---|
DefaultFormValue |
Booleana | Valor predeterminado para una columna Sí/No. |
OptionSet |
Objecto | Opciones para la columna booleana donde cada opción es un par clave-valor. |
Columnas de elección (PicklistAttributeMetadata)
Las columnas de elección tienen esta propiedad:
| Name | Type | Description |
|---|---|---|
OptionSet |
Objecto | Opciones para la columna donde cada opción es un par clave:valor. |
Columnas de opciones (MultiSelectPicklistAttributeMetadata)
Las columnas de opciones tienen estas propiedades:
| Name | Type | Description |
|---|---|---|
DefaultFormValue |
Booleana | Valor predeterminado para la columna. |
OptionSet |
Objecto | Opciones para la columna booleana donde cada opción es un par clave-valor. |
Columnas de estado (StateAttributeMetadata)
Las columnas de estado tienen esta propiedad:
| Name | Type | Description |
|---|---|---|
OptionSet |
Objecto | Opciones para la columna donde cada opción es un par clave:valor. |
Las columnas de estado también tienen estos métodos que aceptan el valor de uno de los valores de opción OptionSet como el parámetro arg.
| Name | Tipo devuelto | Description |
|---|---|---|
getDefaultStatus(arg) |
Number | Devuelve el estado predeterminado (número) basado en el valor de estado pasado para una tabla. Para conocer el estado predeterminado y los valores de estado de una tabla, consulte la información sobre definiciones de la tabla en la referencia de tabla/entidad Dataverse. |
getStatusValuesForState(arg) |
Matriz de números | Devuelve posibles valores de estado (matriz de números) para un valor de estado especificado. Para conocer el estado y los valores de estado de una tabla, consulte la información sobre definiciones de la tabla en la referencia de tabla/entidad de Dataverse. |
Columnas de estado (StatusAttributeMetadata)
Las columnas de estado tienen esta propiedad:
| Name | Type | Description |
|---|---|---|
OptionSet |
Objecto | Opciones para la columna donde cada opción es un par clave:valor. |
Las columnas de estado también tienen este método que acepta el valor de uno de los valores de opción OptionSet como el parámetro arg.
| Name | Tipo devuelto | Description |
|---|---|---|
getState(arg) |
Number | Devuelve el valor de estado (número) por el valor de estado especificado (número). Para conocer el estado predeterminado y los valores de estado de una tabla, consulte la información sobre definiciones de la tabla en la referencia de tabla/entidad Dataverse. |