retrieveRecord (referência da API do cliente)

Recupera um registro de tabela.

Sintaxe

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parâmetros

Opções

Para controlar o que é retornado, use as opções de consulta do $select sistema OData e $expand OData para recuperar seus dados.

Use a opção de consulta do $select sistema para limitar as propriedades retornadas, incluindo uma lista separada por vírgulas de nomes de propriedades. Selecionar propriedades específicas é uma prática recomendada de desempenho importante. Se as propriedades não forem especificadas usando $select, todas as propriedades serão retornadas.

Use a opção de consulta do $expand sistema para controlar quais dados de tabelas relacionadas são retornados. Se você incluir apenas o nome da propriedade de navegação, receberá todas as propriedades para registros relacionados. Você pode limitar as propriedades retornadas para registros relacionados usando a opção de consulta do $select sistema em parênteses após o nome da propriedade de navegação. Use isso para propriedades de navegação de valor único e com valor de coleção . Para offline, só há suporte para a opção aninhada $select dentro do $expand.

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)

Veja exemplos para ver como você pode definir o parâmetro de opções para vários cenários de recuperação.

Valor de retorno

Com êxito, retorna uma promessa que contém um objeto JSON com as colunas recuperadas e seus valores. Se o registro solicitado não existir, retornará um erro.

Exemplos

Veja os seguintes exemplos:

• Recuperação básica
• Recuperar tabelas relacionadas para uma instância de tabela expandindo propriedades de navegação com valor único

Recuperação básica

Recupera o nome e a receita de um registro de conta com ID de registro = 5531d753-95af-e711-a94e-000d3a11e605.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

O exemplo acima exibe o texto a seguir no console; você poderá ver outros valores dependendo de seus dados:

Retrieved values: Name: Sample Account, Revenue: 5000000

Recuperar tabelas relacionadas para uma instância de tabela expandindo propriedades de navegação com valor único

O exemplo a seguir demonstra como recuperar o contato de um registro de conta com a ID do registro = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Para o registro de contato relacionado, estamos recuperando apenas as propriedades contactid e fullname .

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

O exemplo acima exibe o texto a seguir no console; você poderá ver outros valores dependendo de seus dados:

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

Artigos relacionados

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi