retrieveRecord (klient-API-reference)

Henter en tabelpost.

Syntaks

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

Parametre

Navn Type Obligatorisk Description
entityLogicalName String Ja Det tabellogiske navn på den post, du vil hente. Eksempel: account.
id String Ja GUID for den tabelpost, du vil hente.
options String Nej OData-systemforespørgselsindstillinger til at styre, hvad der returneres. Se OData-forespørgselsindstillinger for at henteRecord
successCallback Funktion Nej En funktion, der skal kaldes, når en post hentes. Et JSON-objekt med de hentede egenskaber og værdier overføres til funktionen.
errorCallback Funktion Nej En funktion, der skal kaldes, når handlingen mislykkes. Et objekt med følgende egenskaber overføres:
- errorCode:Tal. Fejlkoden som et positivt decimaltal. Fejlkoden, der f.eks. er dokumenteret som 0x80040333 returneres som 2147746611.
- message:Streng. En fejlmeddelelse, der beskriver problemet.

OData-forespørgselsindstillinger til hentning afPost

Hvis du vil styre, hvad metoden returnerer, skal du bruge $select$expand indstillingerne for OData-systemets forespørgsel, når du henter dine data.

Brug systemforespørgselsindstillingen $select til at begrænse de egenskaber, der returneres, ved at inkludere en kommasepareret liste over egenskabsnavne. Valg af bestemte egenskaber er en vigtig bedste praksis for ydeevne. Hvis du ikke angiver egenskaber ved hjælp $selectaf , returnerer metoden alle egenskaber.

Brug systemforespørgselsindstillingen $expand til at styre, hvilke data fra relaterede tabeller der returneres. Hvis du blot inkluderer navnet på navigationsegenskaben, modtager du alle egenskaberne for relaterede poster. Du kan begrænse de egenskaber, der returneres for relaterede poster, ved hjælp $select af systemforespørgselsindstillingen i parenteser efter navnet på navigationsegenskaben. Brug denne indstilling til både navigationsegenskaber med en enkelt værdi og samlingsværdi . I offlinetilstand understøtter metoden kun indlejrede $select indstillinger i $expand.

Du angiver forespørgselsindstillingerne begyndende med ?. Du kan også angive flere forespørgselsindstillinger ved & hjælp af at adskille forespørgselsindstillingerne. Eksempel:

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

Du kan få mere at vide om, hvordan du definerer indstillingsparameteren for forskellige hentningsscenarier, i Eksempler.

Returværdi

Når metoden lykkes, returnerer den et løfte, der indeholder et JSON-objekt med de hentede kolonner og deres værdier. Hvis den ønskede post ikke findes, returnerer metoden en fejl.

Eksempler

Se følgende eksempler:

Grundlæggende hentning

Henter navnet på og indtægten for 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
    }
);

I det foregående eksempel vises følgende tekst i konsollen. Du kan muligvis se andre værdier, afhængigt af dine data:

Retrieved values: Name: Sample Account, Revenue: 5000000

Følgende eksempel viser, hvordan du henter kontakten for en kontopost med post-id = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. For den relaterede kontaktpost henter du kun egenskaberne 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
    }
);

I det foregående eksempel vises følgende tekst i konsollen. Du kan muligvis se andre værdier, afhængigt af dine data:

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi