Compartilhar via

getEntityMetadata (API do Cliente)

Retorna definições de tabela para a tabela especificada.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
entityName String Yes O nome lógico da tabela.
attributes Matriz de cadeias de caracteres Não As colunas para as qual obter definições.
successCallback função Não Uma função a ser chamada quando as definições de tabela são retornadas.
errorCallback função Não Uma função a ser chamada quando a operação falhar.

Devoluções

Tipo: Objeto

Descrição: um objeto que contém as informações de definições de tabela com os seguintes valores.

Nome Tipo Description
ActivityTypeMask Número Se uma atividade personalizada deve aparecer nos menus de atividade no aplicativo Web. 0 indica que a atividade personalizada não aparece; 1 indica que ele aparece.
AutoRouteToOwnerQueue booleano Indica se os registros serão movidos automaticamente para a fila padrão do proprietário quando um registro desse tipo for criado ou atribuído.
CanEnableSyncToExternalSearchIndex booleano Somente para uso interno.
CanTriggerWorkflow booleano Indica se a tabela pode disparar um processo de fluxo de trabalho.
Description String Descrição da tabela.
DisplayCollectionName String Nome de exibição plural para a tabela.
DisplayName String Nome de exibição para a tabela.
EnforceStateTransitions booleano Indica se a tabela imporá transições de estado personalizadas.
EntityColor String O código hexadecimal para representar a cor a ser usada para esta tabela no aplicativo.
EntitySetName String O nome da tabela da API Web definida para esta tabela.
HasActivities booleano Indica se as atividades estão associadas a esta tabela.
IsActivity booleano Indica se a tabela é uma atividade.
IsActivityParty booleano Indica se as mensagens de email podem ser enviadas para um endereço de email armazenado em um registro desse tipo.
IsBusinessProcessEnabled booleano Indica se a tabela está habilitada para fluxos de processo empresarial.
IsBPFEntity booleano Indica se a tabela é uma tabela de fluxo de processo empresarial.
IsChildEntity booleano Indica se a tabela é uma tabela filho.
IsConnectionsEnabled booleano Indica se as conexões estão habilitadas para esta tabela.
IsCustomEntity booleano Indica se a tabela é uma tabela personalizada.
IsCustomizable booleano Indica se a tabela é personalizável.
IsDocumentManagementEnabled booleano Indica se o gerenciamento de documentos está habilitado.
IsDocumentRecommendationsEnabled booleano Indica se as recomendações do documento estão habilitadas.
IsDuplicateDetectionEnabled booleano Indica se a detecção de duplicidades está habilitada.
IsEnabledForCharts booleano Indica se os gráficos estão habilitados.
IsImportable booleano Indica se a tabela pode ser importada usando o Assistente de Importação.
IsInteractionCentricEnabled booleano Indica que a tabela está habilitada para experiência interativa.
IsKnowledgeManagementEnabled booleano Indica se o gerenciamento de conhecimento está habilitado para a tabela.
IsMailMergeEnabled booleano Indica se a mala direta está habilitada para esta tabela.
IsManaged booleano Indica se a tabela faz parte de uma solução gerenciada.
IsOneNoteIntegrationEnabled booleano Indica se a integração do OneNote está habilitada para a tabela.
IsOptimisticConcurrencyEnabled booleano Indica se a simultaneidade otimista está habilitada para a tabela.
IsQuickCreateEnabled booleano Indica se a tabela está habilitada para formulários de criação rápida.
IsStateModelAware booleano Indica se a tabela dá suporte à configuração de transições de estado personalizadas.
IsValidForAdvancedFind booleano Indica se a tabela será mostrada no Advanced Find.
IsVisibleInMobileClient booleano Indica se os usuários do Microsoft Dynamics 365 para tablets podem ver os dados desta tabela.
IsEnabledInUnifiedInterface booleano Indica se a tabela está habilitada para a Interface Unificada.
LogicalCollectionName String O nome da coleção lógica.
LogicalName String O nome lógico da tabela.
ObjectTypeCode Número O código de tipo de tabela.
OwnershipType String O tipo de propriedade da tabela: UserOwned ou OrganizationOwned.
PrimaryIdAttribute String O nome da coluna que é a ID primária da tabela.
PrimaryImageAttribute String O nome da coluna de imagem primária de uma tabela.
PrimaryNameAttribute String O nome da coluna primária de uma tabela.
Privileges Matriz de objetos Objetos que definem o privilégio de segurança para acesso a uma tabela. Consulte o objeto Privilege
Attributes Collection Uma coleção de objetos de definições de coluna. Ver objetos attribute

Objeto Privilege

Os objetos Privilege têm as seguintes propriedades para definir o privilégio de segurança para acesso a uma tabela:

Nome Tipo Description
CanBeBasic booleano Se o privilégio pode ser o nível de acesso básico.
CanBeDeep booleano Se o privilégio pode ser de nível de acesso profundo.
CanBeEntityReference booleano Se o privilégio para uma parte externa pode ser o nível de acesso básico.
CanBeGlobal booleano Se o privilégio pode ser de nível de acesso global.
CanBeLocal booleano Se o privilégio pode ser de nível de acesso local.
CanBeParentEntityReference booleano Se o privilégio de uma parte externa pode ser o nível de acesso pai.
Name String O nome do privilégio.
PrivilegeId String A ID do privilégio.
PrivilegeType Número O tipo de privilégio, que é um dos seguintes:
0: Nenhum
1: Criar
2: Leitura
3: Gravar
4: Excluir
5: Atribuir
6: Compartilhar
7: Acrescentar
8: AppendTo

Objetos de atributo

O objeto retornado depende do tipo de definições de coluna.

Colunas base (AttributeMetadata)

Todas as definições de coluna têm estas propriedades compartilhadas:

Nome Tipo Description
AttributeType Número Tipo de coluna. Para obter uma lista de valores de tipo de coluna, consulte enumeração AttributeTypeCode
DisplayName String Nome de exibição para a coluna
EntityLogicalName String Nome lógico da tabela que contém a coluna.
LogicalName String Nome lógico para a coluna.

Colunas Yes/No (BooleanAttributeMetadata)

As colunas Sim/Não têm estas propriedades:

Nome Tipo Description
DefaultFormValue booleano Valor padrão para uma coluna Sim/Não.
OptionSet Object Opções para a coluna booliana em que cada opção é um par chave:valor.

Colunas Choice (PicklistAttributeMetadata)

As colunas de escolha têm esta propriedade:

Nome Tipo Description
OptionSet Object Opções para a coluna em que cada opção é um par chave:valor.

Colunas Choices (MultiSelectPicklistAttributeMetadata)

As colunas de opções têm estas propriedades:

Nome Tipo Description
DefaultFormValue booleano Valor padrão para a coluna.
OptionSet Object Opções para a coluna booliana em que cada opção é um par chave:valor.

Colunas State (StateAttributeMetadata)

As colunas de estado têm esta propriedade:

Nome Tipo Description
OptionSet Object Opções para a coluna em que cada opção é um par chave:valor.

As colunas de estado também têm esses métodos que aceitam o valor de um dos valores de opção OptionSet como o arg parâmetro.

Nome Tipo de retorno Description
getDefaultStatus(arg) Número Retorna o status padrão (número) com base no valor de estado passado para uma tabela. Para obter valores de status e estado padrão para uma tabela, consulte as informações de definições de tabela da tabela na referência de tabela/entidade do Dataverse.
getStatusValuesForState(arg) Matriz de números Retorna valores de status possíveis (matriz de números) para um valor de estado especificado. Para obter valores de estado e status para uma tabela, consulte as informações de definições de tabela da tabela na referência de tabela/entidade do Dataverse.

Colunas Status (StatusAttributeMetadata)

As colunas de status têm esta propriedade:

Nome Tipo Description
OptionSet Object Opções para a coluna em que cada opção é um par chave:valor.

As colunas de status também têm esse método que aceita o valor de um dos valores de opção OptionSet como o arg parâmetro.

Nome Tipo de retorno Description
getState(arg) Número Retorna o valor de estado (número) para o valor de status especificado (número). Para obter valores de status e estado padrão para uma tabela, consulte as informações de definições de tabela da tabela na referência de tabela/entidade do Dataverse.

Xrm.Utility

  • Last updated on