retrieveRecord (referencia de API de cliente)

Recupera un registro de tabla.

Sintaxis

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

Parámetros

Nombre. Type Obligatorio Description
entityLogicalName String Sí El nombre lógico de la tabla del registro que desea recuperar. Por ejemplo: account.
id String Sí GUID del registro de tabla que desea recuperar.
options String No Opciones de consulta del sistema OData para controlar lo que se devuelve. Consulte opciones de consulta de OData para retrieveRecord.
successCallback Function No Una función para llamar cuando se recupera un registro. Un objeto JSON con las propiedades y valores recuperados se pasa a la función .
errorCallback Function No Una función a la que se llama cuando la operación tiene error. Se pasará un objeto con las siguientes propiedades:
- errorCode: Número. El código de error como número decimal positivo. Por ejemplo, el código de error documentado como 0x80040333 se devolverá como 2147746611.
- message: Cadena. Un mensaje de error que describe el problema.

Opciones de consulta de OData para retrieveRecord

Para controlar lo que devuelve el método, use las opciones de consulta del $select sistema OData y $expand al recuperar los datos.

Use la opción de consulta del sistema $select para limitar las propiedades devueltas incluyendo una lista separada por comas de nombres de propiedad. Seleccionar propiedades específicas es un procedimiento recomendado de rendimiento importante. Si no especifica propiedades mediante $select, el método devuelve todas las propiedades.

Use la opción de consulta del sistema $expand para controlar qué datos de tablas relacionadas se devuelven. Si incluye solo el nombre de la propiedad de navegación, recibirá todas las propiedades de registros relacionados. Puede limitar las propiedades devueltas para los registros relacionados mediante la opción de consulta del $select sistema entre paréntesis después del nombre de la propiedad de navegación. Use esta opción para las propiedades de navegación con valores únicos y con valores de colección . Para sin conexión, el método solo admite la opción anidada $select dentro de $expand.

Especifique las opciones de consulta comenzando con ?. Puede especificar también varias opciones de consulta usando & para separar las opciones de consulta. Por ejemplo:

?$select=name&$expand=primarycontactid($select=contactid,fullname)

Para obtener información sobre cómo definir el parámetro options para varios escenarios de recuperación, consulte Ejemplos.

Valor de retorno

Si se ejecuta correctamente, el método devuelve una promesa que contiene un objeto JSON con las columnas recuperadas y sus valores. Si el registro solicitado no existe, el método devuelve un error.

Ejemplos

Observe los siguientes ejemplos:

Recuperación básica

Recupera el nombre y los ingresos de un registro de cuenta con el identificador 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
    }
);

En el ejemplo anterior se muestra el texto siguiente en la consola. Es posible que vea otros valores en función de los datos:

Retrieved values: Name: Sample Account, Revenue: 5000000

El ejemplo siguiente muestra cómo recuperar el contacto para un registro de cuenta con el Id. de registro = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Para el registro de contacto relacionado, solo se recuperan las propiedades contactid y 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
    }
);

En el ejemplo anterior se muestra el texto siguiente en la consola. Es posible que vea otros valores en función de los datos:

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi