getEntityMetadata (Referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 1.0

Devuelve los metadatos de la entidad especificada.

Sintaxis

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

Parámetros

Name	Type	Obligatorio	Descripción
entityName	String	Sí	Nombre lógico de la entidad.
attributes	Matriz de cadenas	No	Los atributos para los que se obtienen los metadatos.

Devoluciones

Tipo: Objeto

Descripción: un objeto que contiene la información de los metadatos de la entidad con los siguientes atributos.

Nombre de atributo	Tipo	Descripción
ActivityTypeMask	Número	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	Valor booleano	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	Valor booleano	Solo para uso interno.
CanTriggerWorkflow	Valor booleano	Indica si la entidad puede desencadenar un proceso de flujo de trabajo.
Descripción	Cadena	Descripción de la entidad.
DisplayCollectionName	Cadena	Nombre plural de la entidad.
DisplayName	Cadena	Nombre de la entidad.
EnforceStateTransitions	Valor booleano	Indica si la entidad aplicará transiciones de estado personalizadas.
EntityColor	Cadena	El código hexadecimal para representar el color que se usará para esta entidad en la aplicación.
EntitySetName	Cadena	El nombre de la entidad de API web activada para esta entidad.
HasActivities	Valor booleano	Indica si las actividades están asociadas a esta entidad.
IsActivity	Valor booleano	Indica si la entidad es una actividad.
IsActivityParty	Valor booleano	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	Valor booleano	Indica si se ha habilitado la entidad para los flujos de proceso de negocio.
IsBPFEntity	Valor booleano	Indica si la entidad es una entidad de flujos de proceso de negocio.
IsChildEntity	Valor booleano	Indica si la entidad es una entidad secundaria.
IsConnectionsEnabled	Valor booleano	Indica si hay conexiones habilitadas para esta entidad.
IsCustomEntity	Valor booleano	Indica si la entidad es una entidad personalizada.
IsCustomizable	Valor booleano	Indica si la entidad se puede personalizar.
IsDocumentManagementEnabled	Valor booleano	Indica si está habilitada la administración de documentos.
IsDocumentRecommendationsEnabled	Boolean	Indica si las recomendaciones de documentos estás habilitadas.
IsDuplicateDetectionEnabled	Boolean	Indica si la detección de duplicados está habilitada.
IsEnabledForCharts	Valor booleano	Indica si los gráficos están habilitados.
IsImportable	Valor booleano	Indica si la entidad se puede importar mediante el Asistente para importación.
IsInteractionCentricEnabled	Valor booleano	Indica si la entidad está habilitada para la experiencia interactiva.
IsKnowledgeManagementEnabled	Valor booleano	Indica si la administración del conocimiento está habilitada para la entidad.
IsMailMergeEnabled	Valor booleano	Indica si combinar correspondencia está habilitada para esta entidad.
IsManaged	Valor booleano	Indica si la entidad forma parte de una solución administrada.
IsOneNoteIntegrationEnabled	Boolean	Indica si la Integración de OneNote está habilitada para la entidad.
IsOptimisticConcurrencyEnabled	Valor booleano	Indica si se ha habilitado la simultaneidad optimista se ha habilitado para la entidad.
IsQuickCreateEnabled	Valor booleano	Indica si la entidad está habilitada para crear formularios rápidamente.
IsStateModelAware	Valor booleano	Indica si la entidad admite la configuración de transiciones de estado personalizadas.
IsValidForAdvancedFind	Boolean	Indica si la entidad se muestra en Búsqueda avanzada.
IsVisibleInMobileClient	Boolean	Indica si los usuarios de Microsoft Dynamics 365 para tabletas pueden ver los datos para esta entidad.
IsEnabledInUnifiedInterface	Valor booleano	Indica si la entidad está habilitada para la interfaz unificada.
LogicalCollectionName	Cadena	El nombre lógico de la colección.
LogicalName	Cadena	El nombre lógico de la entidad.
ObjectTypeCode	Número	El código de tipo de entidad.
OwnershipType	Cadena	El tipo de propiedad para la entidad: “UserOwned” u “OrganizationOwned”.
PrimaryIdAttribute	String	El nombre del atributo que es el identificador principal de la entidad.
PrimaryImageAttribute	String	El nombre del atributo de la imagen principal para una entidad.
PrimaryNameAttribute	Cadena	El nombre del atributo principal para una entidad.
Privilegios	Matriz de objetos	Los metadatos de privilegios para la entidad cuando cada objeto contienen los siguientes atributos para definir el privilegio de seguridad para obtener acceso a una entidad: CanBeBasic: booleano. Si el privilegio puede ser un nivel de acceso básico. CanBeDeep: booleano. Si el privilegio puede ser un nivel de acceso exhaustivo. CanBeEntityReference: booleano. Si el privilegio para una parte externa puede ser un nivel de acceso básico. CanBeGlobal: booleano. Si el privilegio puede ser un nivel de acceso global. CanBeLocal: booleano. Si el privilegio puede ser un nivel de acceso local. CanBeParentEntityReference: booleano. Si el privilegio para una parte externa puede ser un nivel de acceso principal. Name: cadena. El nombre del privilegio. PrivilegeId: cadena. El identificador del privilegio. PrivilegeType: número. 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
Atributos	Recogida	Una colección de objetos de metadatos de atributo. El objeto devuelto depende del tipo de metadatos de atributo. Metadatos de atributo para el tipo básico Un objeto devuelto con las siguientes propiedades: AttributeType: número. Tipo de un atributo. Para una lista de valores del tipo de atributo, consulte AttributeTypeCode DisplayName: cadena. Muestra el nombre del atributo. EntityLogicalName: cadena. Nombre lógico de la entidad que contiene el atributo. LogicalName: cadena. Nombre lógico del atributo. Metadatos de atributo para el tipo booleano Un objeto devuelto con las siguientes propiedades además las propiedades de tipo de metadatos de atributo base: DefaultFormValue: booleano. Valor predeterminado para un conjunto de opciones booleanas. OptionSet: objeto. Opciones para el atributo booleano donde cada opción es un par clave-valor. Metadatos de atributo para el tipo enumeración Un objeto devuelto con las siguientes propiedades además las propiedades de tipo de metadatos de atributo base: OptionSet: objeto. Opciones para el atributo donde cada opción es un par clave-valor. Metadatos de atributo para el tipo lista desplegable Un objeto devuelto con las siguientes propiedades además las propiedades de tipo de metadatos de atributo base: DefaultFormValue: número. Valor predeterminado del formulario para el atributo. OptionSet: objeto. Opciones para el atributo donde cada opción es un par clave-valor. Metadatos de atributo para el tipo estado Un objeto devuelto con las siguientes propiedades además las propiedades de tipo de metadatos de atributo base: OptionSet: objeto. Opciones para el atributo donde cada opción es un par clave-valor. El objeto también contiene los siguientes métodos: getDefaultStatus(arg): devuelve el estado predeterminado (número) basado en valor de estado pasado para una entidad. Para los valores de estado predeterminados de una entidad, consulte la información de los metadatos de la entidad en referencia de entidad. getStatusValuesForState(arg): devuelve los posibles valores del estado (matriz de números) para un valor especificado de estado. Para los valores de estado de una entidad, consulte la información de los metadatos de la entidad en referencia de entidad. Metadatos de atributo para el tipo estado Un objeto devuelto con las siguientes propiedades además las propiedades de tipo de metadatos de atributo base: OptionSet: objeto. Opciones para el atributo donde cada opción es un par clave-valor. El objeto también contiene el siguiente método: getState(arg): devuelve el valor de estado (número) por el valor de estado especificado (número). Para los valores de estado predeterminados de una entidad, consulte la información de los metadatos de la entidad en referencia de entidad.