retrieveRecord (referenční informace k rozhraní API klienta)

Načte záznam tabulky.

Syntaxe

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

Parametry

Název Typ Povinné Description
entityLogicalName String Ano Logický název záznamu, který chcete načíst. Například: account.
id String Ano IDENTIFIKÁTOR GUID záznamu tabulky, který chcete načíst.
options String Ne Možnosti systémového dotazu OData pro řízení vrácených hodnot. Zobrazit možnosti
successCallback Funkce Ne Funkce, která se má volat při načtení záznamu. Objekt JSON s načtenými vlastnostmi a hodnotami předanými funkci.
errorCallback Funkce Ne Funkce, která se má volat v případě selhání operace. Předá se objekt s následujícími vlastnostmi:
- errorCode:Číslo. Kód chyby jako kladné desetinné číslo. Například kód chyby zdokumentovaný tak, jak 0x80040333 bude vrácen jako 2147746611.
- message:Řetězec. Chybová zpráva popisující problém.

Možnosti

Pokud chcete určit, co se vrátí, použijte možnosti systémového $select$expand dotazu OData k načtení dat.

Pomocí možnosti systémového $select dotazu omezte vlastnosti vrácené zahrnutím seznamu názvů vlastností oddělených čárkami. Výběr konkrétních vlastností je důležitým osvědčeným postupem z hlediska výkonu. Pokud nejsou vlastnosti zadány pomocí $select, vrátí se všechny vlastnosti.

Pomocí možnosti systémového $expand dotazu můžete určit, jaká data ze souvisejících tabulek se vrátí. Pokud pouze zahrnete název navigační vlastnosti, obdržíte všechny vlastnosti pro související záznamy. Vlastnosti vrácené pro související záznamy můžete omezit pomocí možnosti systémového $select dotazu v závorkách za názvem navigační vlastnosti. Tuto možnost použijte pro navigační vlastnosti s hodnotou jedné hodnoty i pro vlastnosti s hodnotou kolekce . Pro offline režim podporujeme pouze vnořenou $select možnost uvnitř souboru $expand.

Volby dotazu se zadávají začínající .? Můžete také zadat více možností dotazu pomocí k & oddělení možností dotazu. Například:

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

V příkladech se dozvíte, jak můžete definovat parametr možností pro různé scénáře načtení.

Návratová hodnota

Při úspěchu vrátí příslib obsahující objekt JSON s načtenými sloupci a jejich hodnotami. Pokud požadovaný záznam neexistuje, vrátí chybu.

Examples

Podívejte se na následující příklady:

Základní načtení

Načte název a výnosy záznamu účtu s ID záznamu = 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
    }
);

Výše uvedený příklad zobrazí následující text v konzole; V závislosti na datech se můžou zobrazit další hodnoty:

Retrieved values: Name: Sample Account, Revenue: 5000000

Následující příklad ukazuje, jak načíst kontakt pro záznam účtu s ID záznamu = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. U souvisejícího záznamu kontaktu načítáme pouze vlastnosti contactid a 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
    }
);

Výše uvedený příklad zobrazí následující text v konzole; V závislosti na datech se můžou zobrazit další hodnoty:

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