retrieveRecord (referenca klijentskog API-ja)

Dohvaća zapis tablice.

Sintaksa

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

Parametri

Ime/naziv	Tip	Obvezno	Opis
entityLogicalName	String	Da	Logički naziv tablice zapisa koji želite dohvatiti. Na primjer: account.
id	String	Da	GUID zapisa tablice koji želite dohvatiti.
options	String	Ne	Mogućnosti upita sustava OData za upravljanje vraćenim resursima. Pogledajte mogućnosti
successCallback	Funkcija	Ne	Funkcija za pozivanje prilikom dohvaćanja zapisa. JSON objekt s dohvaćenim svojstvima i vrijednostima proslijedenim funkciji.
errorCallback	Funkcija	Ne	Funkcija za pozivanje kada operacija ne uspije. Prosljeđuje se objekt sa sljedećim svojstvima: - errorCode:Broj. Kôd pogreške kao pozitivan decimalni broj. Primjerice, kôd pogreške dokumentiran kao 0x80040333 će se vratiti kao 2147746611. - message:Gudački. Poruka o pogrešci koja opisuje problem.

Mogućnosti

Da biste upravljali vraćenim resursima, dohvatiti $select$expand podatke pomoću mogućnosti upita sustava OData.

Pomoću mogućnosti $select upita sustava ograničite svojstva koja se vraćaju uvrštenjem popisa naziva svojstava odvojenih zarezom. Odabir određenih svojstava važna je najbolja praksa za performanse. Ako svojstva nisu navedena pomoću , vraćaju $selectse sva svojstva.

Pomoću mogućnosti $expand upita sustava kontrolirajte koji se podaci iz povezanih tablica vraćaju. Ako samo uvrstite naziv navigacijskog svojstva, primit ćete sva svojstva povezanih zapisa. Svojstva vraćena za povezane zapise možete ograničiti pomoću mogućnosti $select upita sustava u zagradama nakon naziva navigacijskog svojstva. Koristite ovu opciju za navigacijska svojstva s jednom vrijednošću i za svojstva s vrijednošću zbirke . Za izvanmrežni rad podržavamo samo ugniježđene $select mogućnosti unutar $expand.

Opcije upita navodite počevši od ?. Možete navesti i više mogućnosti upita pomoću razdvajanja & mogućnosti upita. Na primjer:

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

Pogledajte Primjere da biste vidjeli kako definirati parametar mogućnosti za različite scenarije dohvaćanja.

Povratna vrijednost

Prilikom uspjeha vraća obećanje koje sadrži JSON objekt s dohvaćenim stupcima i njihovim vrijednostima. Ako traženi zapis ne postoji, vraća pogrešku.

Primjeri

Pogledajte sljedeće primjere:

• Osnovno dohvaćanje
• Dohvaćanje povezanih tablica za instancu tablice proširivanjem navigacijskih svojstava s jednom vrijednošću

Osnovno dohvaćanje

Dohvaća naziv i prihod zapisa računa s ID-om zapisa = 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
    }
);

U gornjem se primjeru prikazuje sljedeći tekst na konzoli; možda ćete vidjeti druge vrijednosti ovisno o vašim podacima:

Retrieved values: Name: Sample Account, Revenue: 5000000

Dohvaćanje povezanih tablica za instancu tablice proširivanjem navigacijskih svojstava s jednom vrijednošću

Sljedeći primjer pokazuje kako dohvatiti kontakt za zapis računa s ID-om zapisa = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. U povezanom zapisu o kontaktu dohvaćamo samo svojstva ID-a kontakta i punog naziva.

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

U gornjem se primjeru prikazuje sljedeći tekst na konzoli; možda ćete vidjeti druge vrijednosti ovisno o vašim podacima:

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

Povezani članci

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi