retrieveRecord (kliendi API viide)

Toob tabelikirje.

Süntaks

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

Parameetrid

Nimi Liik Nõutav Kirjeldus
entityLogicalName String Ja Toodava kirje tabeli loogiline nimi. Näiteks: account.
id String Ja Selle tabelikirje GUID, mille soovite tuua.
options String Ei OData süsteemipäringu suvandid tagastatava juhtimiseks. Kuva suvandid
successCallback Function Ei Funktsioon, mida kirje toomisel kutsuda. JSON-objekt, millel on funktsioonile edastatud toodud atribuudid ja väärtused.
errorCallback Function Ei Funktsioon, mida kutsuda, kui toiming nurjub. Edastatakse järgmiste atribuutidega objekt:
- errorCode:Arv. Tõrkekood positiivse kümnendarvuna. Näiteks tagastatakse kujul dokumenteeritud 0x80040333 tõrkekood.2147746611
- message:String. Probleemi kirjeldav tõrketeade.

Suvandid

Tagastatava juhtimiseks kasutage $select$expand andmete toomiseks OData süsteemipäringu suvandeid.

$select Süsteemipäringu suvandi abil saate piirata komaeraldusega atribuudinimede loendi kaasamisega tagastatud atribuute. Konkreetsete atribuutide valimine on oluline jõudluse hea tava. Kui atribuudid pole funktsiooniga $selectmääratud, tagastatakse kõik atribuudid.

$expand Süsteemipäringu suvandi abil saate määrata, millised seotud tabelite andmed tagastatakse. Kui lisate lihtsalt navigeerimisatribuudi nime, saate kõik seotud kirjete atribuudid. Seotud kirjete tagastatud atribuute saate piirata, kasutades $select sulgudes pärast navigeerimisatribuudi nime süsteemipäringu suvandit. Kasutage seda nii ühe- kui ka kollektsiooniväärtusega navigeerimisatribuutide puhul. Ühenduseta režiimis toetame ainult pesastatud $select suvandit kaustas $expand.

Määrate päringusuvandid, mis algavad tähega ?. Samuti saate määrata mitu päringusuvandit, kasutades & päringusuvandite eraldamist. Näiteks:

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

Vaadake näiteid , kuidas määratleda erinevate toomisstsenaariumide suvandite parameetrit.

Tagastatav väärtus

Õnnestumisel tagastab lubaduse, mis sisaldab JSON-objekti koos toodud veergude ja nende väärtustega. Kui taotletud kirjet pole olemas, tagastab tõrke.

Näited

Vaadake järgmisi näiteid.

Lihtne toomine

Toob kontokirje nime ja tulu kirje ID-ga = 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
    }
);

Ülaltoodud näites kuvatakse teie konsoolis järgmine tekst; olenevalt andmetest võidakse kuvada ka muid väärtusi.

Retrieved values: Name: Sample Account, Revenue: 5000000

Järgmises näites kirjeldatakse, kuidas tuua kontakt kontokirje jaoks, mille kirje ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Seotud kontaktikirje jaoks toome ainult kontakti id ja täisnime atribuudid.

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

Ülaltoodud näites kuvatakse teie konsoolis järgmine tekst; olenevalt andmetest võidakse kuvada ka muid väärtusi.

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi

  • Last updated on