retrieveRecord (Klient-API-referanse)

Henter en tabellpost.

Syntaks

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

Parametere

Navn Type Obligatorisk Beskrivelse
entityLogicalName Streng Ja Det logiske tabellnavnet for posten du vil hente. Eksempel: account.
id Streng Ja GUID for tabellposten du vil hente.
options Streng Nei Alternativer for OData-systemspørring for å kontrollere hva som returneres. Se OData-spørringsalternativer for retrieveRecord
successCallback Function Nei En funksjon som skal kalles når en post hentes. Et JSON-objekt med de hentede egenskapene og verdiene sendes til funksjonen.
errorCallback Function Nei En funksjon som skal kalles når operasjonen mislykkes. Et objekt med følgende egenskaper sendes:
- errorCode:Nummer. Feilkoden som et positivt desimaltall. Feilkoden som for eksempel er dokumentert som 0x80040333 , returneres som 2147746611.
- message:Streng. En feilmelding som beskriver problemet.

OData-spørringsalternativer for retrieveRecord

Hvis du vil kontrollere hva metoden returnerer, bruker $select du alternativene for $expand OData-systemet når du henter dataene.

$select Bruk alternativet systemspørring til å begrense egenskapene som returneres ved å inkludere en kommadelt liste over egenskapsnavn. Valg av bestemte egenskaper er en viktig anbefalt fremgangsmåte for ytelse. Hvis du ikke angir egenskaper ved hjelp $selectav , returnerer metoden alle egenskapene.

$expand Bruk alternativet for systemspørring til å kontrollere hvilke data fra relaterte tabeller som returneres. Hvis du bare inkluderer navnet på navigasjonsegenskapen, mottar du alle egenskapene for relaterte poster. Du kan begrense egenskapene som returneres for relaterte poster ved hjelp $select av alternativet for systemspørring i parenteser etter navnet på navigasjonsegenskapen. Bruk dette alternativet for både navigasjonsegenskaper med enkel verdi og samlingsverdi . Metoden støtter bare nestet $select alternativ i frakoblet modus i $expand.

Du angir spørringsalternativene fra og med ?. Du kan også angi flere spørringsalternativer ved å bruke & til å skille spørringsalternativene. Eksempel:

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

Hvis du vil lære hvordan du definerer alternativparameteren for ulike hentescenarioer, kan du se Eksempler.

returverdi

Ved suksess returnerer metoden et løfte som inneholder et JSON-objekt med de hentede kolonnene og deres verdier. Hvis den forespurte posten ikke finnes, returnerer metoden en feil.

Eksempler

Se følgende eksempler:

Grunnleggende henting

Henter navnet og inntekten til en kontopost med post-ID = 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
    }
);

Det foregående eksemplet viser følgende tekst i konsollen. Du kan se andre verdier avhengig av dataene:

Retrieved values: Name: Sample Account, Revenue: 5000000

Eksemplet nedenfor viser hvordan du henter kontakten for en forretningsforbindelsesoppføring med post-ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. For den relaterte kontaktoppføringen henter du bare egenskapene contactid og 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
    }
);

Det foregående eksemplet viser følgende tekst i konsollen. Du kan se andre verdier avhengig av dataene:

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi