retrieveRecord (kliento API nuoroda)

Nuskaito lentelės įrašą.

Sintaksė

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

Parametrus

Vardas, pavadinimas	Rūšis	Privalomas	Aprašą
entityLogicalName	String	Taip	Lentelės loginis įrašo, kurį norite gauti, pavadinimas. Pavyzdžiui: account.
id	String	Taip	Lentelės įrašo, kurį norite gauti, GUID.
options	String	Ne	"OData" sistemos užklausos parinktys, valdančios, kas pateikiama. Žr . parinktis
successCallback	Funkcija	Ne	Funkcija, kurią reikia iškviesti, kai nuskaitomas įrašas. JSON objektas su nuskaitytas ypatybėmis ir reikšmėmis, perduotomis funkcijai.
errorCallback	Funkcija	Ne	Funkcija, kurią reikia iškviesti, kai operacija nepavyksta. Perduotas objektas su šiomis ypatybėmis: - errorCode:Numeris. Klaidos kodas kaip teigiamas dešimtainis skaičius. Pavyzdžiui, klaidos kodas, dokumentuotas kaip 0x80040333 bus grąžintas kaip 2147746611. - message:Eilutės. Klaidos pranešimas, apibūdinantis problemą.

Parinktys

Norėdami valdyti, kas grąžinama, naudokite $select sistemos " $expand OData" užklausos parinktis, kad gautumėte duomenis.

$select Naudokite sistemos užklausos parinktį, kad apribotumėte pateiktas ypatybes įtraukdami kableliais atskirtų ypatybių pavadinimų sąrašą. Konkrečių ypatybių pasirinkimas yra svarbi geriausia veikimo praktika. Jei ypatybės nenurodytos naudojant $select, grąžinamos visos ypatybės.

$expand Naudokite sistemos užklausos parinktį, kad valdytumėte, kokie duomenys iš susijusių lentelių pateikiami. Jei tiesiog įtraukiate naršymo ypatybės pavadinimą, gausite visas susijusių įrašų ypatybes. Galite apriboti susijusių įrašų pateiktas ypatybes naudodami $select sistemos užklausos parinktį skliausteliuose po naršymo ypatybės pavadinimo. Naudokite tiek vienos reikšmės, tiek kolekcijos vertės naršymo ypatybėms. Neprisijungus palaikome tik įdėtąją $select$expandparinktį viduje .

Užklausos pasirinktis galite nurodyti pradėdami nuo ?. Taip pat galite nurodyti kelias užklausos parinktis naudodami & užklausos parinktis atskirti. Pavyzdys.

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

Žr . Pavyzdžiai , kaip galite apibrėžti įvairių scenarijų gavimas parinkčių parametrą.

Grąžinama reikšmė

Sėkmingai pateikia pažadą, kuriame yra JSON objektas su gautais stulpeliais ir jų reikšmėmis. Jei pageidaujamo įrašo nėra, pateikia klaidą.

Pavyzdžiai

Peržiūrėkite šiuos pavyzdžius:

• Pagrindinis gavimas
• Susijusių lentelių gavimas lentelės egzemplioriui išplečiant vienos reikšmės naršymo ypatybes

Pagrindinis gavimas

Nuskaito kliento įrašo, kurio įrašo ID = 5531d753-95af-e711-a94e-000d3a11e605, pavadinimą ir pajamas.

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
    }
);

Aukščiau pateiktame pavyzdyje rodomas šis tekstas jūsų konsolėje; atsižvelgiant į jūsų duomenis, galite matyti kitas reikšmes:

Retrieved values: Name: Sample Account, Revenue: 5000000

Susijusių lentelių gavimas lentelės egzemplioriui išplečiant vienos reikšmės naršymo ypatybes

Šiame pavyzdyje parodyta, kaip gauti kliento įrašo, kurio įrašo ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200, kontaktą. Susijusį kontakto įrašą gauname tik kontakto id ir viso vardo ypatybes.

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
    }
);

Aukščiau pateiktame pavyzdyje rodomas šis tekstas jūsų konsolėje; atsižvelgiant į jūsų duomenis, galite matyti kitas reikšmes:

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

Susiję straipsniai

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi