retrieveRecord (referència de l'API del client)

Recupera un registre de taula.

Sintaxi

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

Paràmetres

Nom	Tipus	Necessari	Descripció
entityLogicalName	String	Sí	El nom lògic de la taula del registre que voleu recuperar. Per exemple: account.
id	String	Sí	GUID del registre de taula que voleu recuperar.
options	String	No	Opcions de consulta del sistema OData per controlar el que es retorna. Veure opcions
successCallback	Function	No	Funció per cridar quan es recupera un registre. Objecte JSON amb les propietats i valors recuperats passats a la funció.
errorCallback	Function	No	Una funció per cridar quan l'operació falla. Es passa un objecte amb les propietats següents: - errorCode:Número. El codi d'error com a nombre decimal positiu. Per exemple, el codi d'error documentat com es 0x80040333 retornarà com 2147746611a . - message:Corda. Un missatge d'error que descriu el problema.

Opcions

Per controlar el que es retorna, utilitzeu les opcions de consulta del $select sistema i $expand OData per recuperar les dades.

Utilitzeu l'opció de $select consulta del sistema per limitar les propietats retornades incloent una llista separada per comes de noms de propietats. La selecció de propietats específiques és una bona pràctica de rendiment important. Si les propietats no s'especifiquen mitjançant $selectel , es retornen totes les propietats.

Utilitzeu l'opció de $expand consulta del sistema per controlar quines dades de les taules relacionades es retornen. Si només incloeu el nom de la propietat de navegació, rebreu totes les propietats dels registres relacionats. Podeu limitar les propietats retornades per als registres relacionats mitjançant l'opció $select de consulta del sistema entre parèntesis després del nom de la propietat de navegació. Utilitzeu-ho per a les propietats de navegació d'un sol valor i de valor de col·lecció . Per a fora de línia, només admetem l'opció imbricada $select dins del $expand.

Especifiqueu les opcions de consulta que comencen per ?. També podeu especificar diverses opcions de consulta per & separar les opcions de consulta. Per exemple:

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

Vegeu Exemples per veure com podeu definir el paràmetre options per a diversos escenaris de recuperació.

Valor de retorn

En cas d'èxit, retorna una promesa que conté un objecte JSON amb les columnes recuperades i els seus valors. Si el registre sol·licitat no existeix, retorna un error.

Exemples

Vegeu els exemples següents:

• Recuperació bàsica
• Recuperar taules relacionades per a una instància de taula expandint propietats de navegació d'un sol valor

Recuperació bàsica

Recupera el nom i els ingressos d'un registre de compte amb l'identificador de registre = 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
    }
);

L'exemple anterior mostra el text següent a la consola; És possible que vegeu altres valors en funció de les vostres dades:

Retrieved values: Name: Sample Account, Revenue: 5000000

Recuperar taules relacionades per a una instància de taula expandint propietats de navegació d'un sol valor

L'exemple següent mostra com recuperar el contacte d'un registre de compte amb l'identificador de registre = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Per al registre de contacte relacionat, només recuperem les propietats contactid i 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
    }
);

L'exemple anterior mostra el text següent a la consola; És possible que vegeu altres valors en funció de les vostres dades:

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

Articles relacionats

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi