Partilhar via

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

Recupera um registro de entidade.

Sintaxe

Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Obrigatório Description
entityLogicalName Cordão Yes O nome lógico da entidade do registro que você deseja recuperar. Por exemplo: "conta".
id Cordão Yes GUID do registro de entidade que você deseja recuperar.
options Cordão Não

Opções de consulta do sistema OData, $select e $expand, para recuperar seus dados.

  • Use a opção $select consulta do sistema para limitar as propriedades retornadas incluindo uma lista separada por vírgulas de nomes de propriedades. Trata-se de uma importante prática recomendada em termos de desempenho. Se as propriedades não forem especificadas usando $select, todas as propriedades serão retornadas.
  • Use a opção $expand consulta do sistema para controlar quais dados de entidades relacionadas são retornados. Se você incluir apenas o nome da propriedade de navegação, receberá todas as propriedades dos registros relacionados. Você pode limitar as propriedades retornadas para registros relacionados usando a opção $select consulta do sistema entre parênteses após o nome da propriedade de navegação. Use isso para propriedades de navegação com valor único e com valor de coleção .

Você especifica as opções de consulta começando com ?. Você também pode especificar várias opções de consulta usando & para separar as opções de consulta. Por exemplo:

?$select=name&$expand=primarycontactid($select=contactid,fullname)
successCallback Função Não

Uma função para chamar quando um registro é recuperado.
errorCallback Função Não Uma função para chamar quando a operação falhar.

Valor de retorno

Quando for bem-sucedido, retorna uma promessa contendo uma cadeia de caracteres com os atributos recuperados e seus valores.

Examples

Este código de exemplo recupera o nome e o número de telefone de um registro de contato com ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200.

// retrieve contact record
var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
var entityLogicalName = "contact";
Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, "?$select=fullname,telephone1").then(
    function success(result) {
      res=JSON.parse(result);
        console.log(`Retrieved values: Full Name: ${res.fullname}, Telephone Number: ${res.telephone1}`);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);
  • Last updated on