retrieveRecord (asiakkaan ohjelmointirajapinnan viittaus)

Noutaa taulukkotietueen.

Syntaksi

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

Parametrit

Nimi Type Pakollinen Description
entityLogicalName Merkkijono Kyllä Noudettavan tietueen looginen nimi taulukossa. Esimerkki: account.
id Merkkijono Kyllä Haettavan taulukkotietueen GUID-tunnus.
options Merkkijono Ei OData-järjestelmän kyselyasetukset palautettavan kohteen hallitsemiseksi. Katso OData-kyselyasetuksetRecord-kohteen noutamista varten
successCallback Function Ei Funktio, jota kutsutaan, kun tietue noudetaan. JSON-objekti, jolla on noudetut ominaisuudet ja arvot, välitetään funktiolle.
errorCallback Function Ei Funktio, jota kutsutaan, kun toiminto epäonnistuu. Objekti, jolla on seuraavat ominaisuudet, välitetään:
- errorCode:Numero. Virhekoodi positiivisena desimaalilukuna. Esimerkiksi virhekoodi, joka on dokumentoitu muodossa 0x80040333 , palautetaan muodossa 2147746611.
- message:Merkkijono. Ongelmaa kuvaava virheilmoitus.

OData-kyselyasetuksetRecord-kohteen noutamista varten

Voit hallita sitä, mitä menetelmä palauttaa, käyttämällä - $select ja $expand OData-järjestelmän kyselyasetuksia, kun noudat tietoja.

Järjestelmäkysely-asetuksen $select avulla voit rajoittaa palautettuja ominaisuuksia sisällyttämällä pilkuin eroteltujen ominaisuuksien nimien luettelon. Tiettyjen ominaisuuksien valitseminen on tärkeä suorituskykyyn liittyvä paras käytäntö. Jos et määritä ominaisuuksia :n avulla $select, -menetelmä palauttaa kaikki ominaisuudet.

Järjestelmäkysely-asetuksen $expand avulla voit hallita, mitä tietoja liittyvistä taulukoista palautetaan. Jos sisällytät vain siirtymisominaisuuden nimen, saat liittyvien tietueiden kaikki ominaisuudet. Voit rajoittaa liittyvien tietueiden palauttamia ominaisuuksia käyttämällä $select järjestelmäkyselyasetusta sulkeissa siirtymisominaisuuden nimen jälkeen. Käytä tätä asetusta sekä yksiarvoisille että kokoelma-arvoisille siirtymisominaisuuksille. Offline-tilassa -menetelmä tukee vain sisäkkäistä $select asetusta -palvelussa $expand.

Määrität kyselyn asetukset, jotka alkavat .? Voit myös määrittää useita kyselyasetuksia & erottamalla kyselyasetukset toisistaan. Esimerkki:

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

Lisätietoja asetusparametrin määrittämisestä eri nouda-skenaarioita varten on kohdassa Esimerkkejä.

Palautusarvo

Onnistuttua menetelmä palauttaa lupauksen, joka sisältää JSON-objektin, jossa on noudetut sarakkeet ja niiden arvot. Jos pyydettyä tietuetta ei ole, -menetelmä palauttaa virheen.

Esimerkkejä

Katso seuraavia esimerkkejä:

Perus nouto

Hakee tilitietueen nimen ja tuoton, jonka tietuetunnus on = 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
    }
);

Edellä olevassa esimerkissä seuraava teksti näkyy konsolissasi. Saatat nähdä muita tietoihisi perustuvia arvoja:

Retrieved values: Name: Sample Account, Revenue: 5000000

Seuraavassa esimerkissä näytetään, miten noudetaan yhteyshenkilö tilitietueelle, jonka tietuetunnus on = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Liittyvää yhteystietotietuetta varten nouda vain contactid - ja fullname-ominaisuudet .

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

Edellä olevassa esimerkissä seuraava teksti näkyy konsolissasi. Saatat nähdä muita tietoihisi perustuvia arvoja:

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi