Compartir vía

retrieveRecord (referencia de API de cliente)

  • Artículo

Recupera un registro de tabla.

Sintaxis

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

Parámetros

Name 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. Ver Opciones
successCallback Function No Una función para llamar cuando se recupera un registro. Se pasará a la función un objeto JSON con las propiedades y los valores recuperados.
errorCallback Function No Una función a la que se llama cuando la operación tiene error.

Opciones

Para controlar lo que se devolverá, utilice las opciones de consulta del sistema OData $select y $expand para recuperar sus 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 las propiedades no se especifican utilizando $select, todas las propiedades se devolverán.

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 registros relacionados con la opción de la consulta del sistema $select entre paréntesis después del nombre de propiedad de navegación. Use esta opción para las propiedades de navegación de un solo valor y valoradas como colección. Para fuera de línea solo admitimos la opción $select anidada 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)

Vea los ejemplos más adelante en este tema para saber cómo puede definir el parámetro de opciones para distintos escenarios de recuperación.

Valor devuelto

En caso de resultar correcto, devuelve una promesa con un objeto JSON con las columnas recuperadas y sus valores. Si el registro solicitado no existe, 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
    }
);

El ejemplo anterior muestra el siguiente texto en la consola; puede ver otros valores dependiendo 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 estamos recuperando 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
    }
);

El ejemplo anterior muestra el siguiente texto en la consola; puede ver otros valores dependiendo 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

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).