Compartilhar via

getEntityMetadata (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 1.0

Retorna os metadados da entidade especificada.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
entityName String Yes O nome lógico da entidade.
attributes Matriz de cadeias de caracteres Não Os atributos para os quais obter metadados.

Devoluções

Tipo: Objeto

Descrição: um objeto que contém as informações de metadados da entidade com os atributos a seguir.

Nome do atributo 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 devem ser movidos automaticamente para a fila padrão do proprietário quando um registro desse tipo é criado ou atribuído.
CanEnableSyncToExternalSearchIndex booleano Somente para uso interno.
Fluxo de trabalho CanTriggerTrigger booleano Indica se a entidade pode disparar um processo de fluxo de trabalho.
Description String Descrição da entidade.
DisplayCollectionName String Nome de exibição plural da entidade.
DisplayName String Nome de exibição da entidade.
EnforceStateTransitions booleano Indica se a entidade imporá transições de estado personalizadas.
Cor da entidade String O código hexadecimal para representar a cor a ser usada para essa entidade no aplicativo.
EntitySetName String O nome da entidade da API Web definida para essa entidade.
HasActivities booleano Indica se as atividades estão associadas a essa entidade.
ÉAtividade booleano Indica se a entidade é uma atividade.
ÉAtividadePartido 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 entidade está habilitada para fluxos do processo empresarial.
IsBPFEntity booleano Indica se a entidade é uma entidade de fluxo do processo empresarial.
ÉCriançaEntidade booleano Indica se a entidade é uma entidade filho.
IsConnectionsEnabled booleano Indica se as conexões estão habilitadas para essa entidade.
ÉCustomEntity booleano Indica se a entidade é uma entidade personalizada.
Épersonalizável booleano Indica se a entidade é personalizável.
IsDocumentManagementEnabled booleano Indica se o gerenciamento de documentos está habilitado.
IsDocumentRecommendationsEnabled booleano Indica se as recomendações de documentos estão habilitadas.
IsDuplicateDetectionEnabled booleano Indica se a detecção de duplicidades está habilitada.
IsEnabledForCharts booleano Indica se os gráficos estão habilitados.
ÉImportável booleano Indica se a entidade pode ser importada usando o Assistente de Importação.
IsInteractionCentricEnabled booleano Indica que a entidade está habilitada para experiência interativa.
IsKnowledgeManagementEnabled booleano Indica se o gerenciamento do conhecimento está habilitado para a entidade.
IsMailMergeEnabled booleano Indica se a mala direta está habilitada para essa entidade.
IsManaged booleano Indica se a entidade faz parte de uma solução gerenciada.
IsOneNoteIntegrationEnabled booleano Indica se a integração do OneNote está habilitada para a entidade.
IsOptimisticConcurrencyEnabled booleano Indica se a simultaneidade otimista está habilitada para a entidade.
IsQuickCreateEnabled booleano Indica se a entidade está habilitada para formulários de criação rápida.
IsStateModelAware booleano Indica se a entidade dá suporte à configuração de transições de estado personalizadas.
IsValidForAdvancedFind booleano Indica se a entidade é mostrada na Localização Avançada.
IsVisibleInMobileClient booleano Indica se os usuários do Microsoft Dynamics 365 para tablets podem ver os dados dessa entidade.
IsEnabledInUnifiedInterface booleano Indica se a entidade está habilitada para a Interface Unificada.
Nome_da_ColeçãoLógica String O nome da coleção lógica.
Nome lógico String O nome lógico da entidade.
Código do tipo de objeto Número O código do tipo de entidade.
Tipo de propriedade String O tipo de propriedade da entidade: "UserOwned" ou "OrganizationOwned".
Atributo Primário String O nome do atributo que é a ID primária da entidade.
Atributo de imagem primária String O nome do atributo de imagem primária de uma entidade.
Atributo Primário String O nome do atributo primário de uma entidade.
Privilégios Matriz de objetos Os metadados de privilégio para a entidade em que cada objeto contém os seguintes atributos para definir o privilégio de segurança para acesso a uma entidade:
  • 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.
  • Nome: String. O nome do privilégio.
  • PrivilegeId: Cadeia de caracteres. A ID do privilégio.
  • PrivilegeType: Número. O tipo de privilégio, que é um dos seguintes:
    • 0: Nenhum
    • 1: Criar
    • 2: Leia
    • 3: Escreva
    • 4: Excluir
    • 5: Atribuir
    • 6: Compartilhar
    • 7: Anexar
    • 8: Anexar a
Attributes Collection Uma coleção de objetos de metadados de atributo. O objeto retornado depende do tipo de metadados de atributo.

Metadados de atributo para o tipo base
Um objeto retornado com as seguintes propriedades:

  • AttributeType: Número. Tipo de um atributo. Para obter uma lista de valores de tipo de atributo, consulte AttributeTypeCode
  • DisplayName: Cadeia de caracteres. Nome de exibição do atributo.
  • EntityLogicalName: Cadeia de caracteres. Nome lógico da entidade que contém o atributo.
  • LogicalName: Cadeia de caracteres. Nome lógico para o atributo.

Metadados de atributo para o tipo booleano
Um objeto retornado com as seguintes propriedades, além das propriedades do tipo de metadados do atributo base :

  • DefaultFormValue: Booleano. Valor padrão para um conjunto de opções booleanas.
  • OptionSet: Objeto. Opções para o atributo booleano em que cada opção é um par chave:valor.

Metadados de atributo para o tipo de enumeração
Um objeto retornado com as seguintes propriedades, além das propriedades do tipo de metadados do atributo base :

  • OptionSet: Objeto. Opções para o atributo em que cada opção é um par chave:valor.

Metadados de atributo para o tipo de lista de opções
Um objeto retornado com as seguintes propriedades, além das propriedades do tipo de metadados do atributo base :

  • DefaultFormValue: Número. Valor de formulário padrão para o atributo.
  • OptionSet: Objeto. Opções para o atributo em que cada opção é um par chave:valor.

Metadados de atributo para o tipo de estado
Um objeto retornado com as seguintes propriedades, além das propriedades do tipo de metadados do atributo base :

  • OptionSet: Objeto. Opções para o atributo em que cada opção é um par chave:valor.

O objeto também contém os seguintes métodos:

  • getDefaultStatus(arg): retorna o status padrão (número) com base no valor de estado passado para uma entidade. Para obter os valores padrão de estado e status de uma entidade, consulte informações de metadados da entidade na referência da entidade.
  • getStatusValuesForState(arg): retorna valores de status possíveis (matriz de números) para um valor de estado especificado. Para obter valores de estado e status de uma entidade, consulte informações de metadados da entidade na referência da entidade.

Metadados de atributo para o tipo de status
Um objeto retornado com as seguintes propriedades, além das propriedades do tipo de metadados do atributo base :

  • OptionSet: Objeto. Opções para o atributo em que cada opção é um par chave:valor.

O objeto também contém o seguinte método:

  • getState(arg): Retorna o valor do estado (número) para o valor de status especificado (número). Para obter os valores padrão de estado e status de uma entidade, consulte informações de metadados da entidade na referência da entidade.
  • Last updated on