retrieveRecord (referință API client)

Regăsește o înregistrare de tabel.

Sintaxă

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

Parametrii

Nume Tip Obligatoriu Descriere
entityLogicalName Șir Da Numele logic al înregistrării pe care doriți să o regăsiți. De exemplu: account.
id Șir Da GUID-ul înregistrării de tabel pe care doriți să o regăsiți.
options Șir Nu Opțiuni interogare sistem OData pentru a controla ce se returnează. Vedeți opțiunile
successCallback Funcţie Nu O funcție de apelat atunci când se preia o înregistrare. Un obiect JSON cu proprietățile regăsite și valorile transmise funcției.
errorCallback Funcţie Nu O funcție de apelat atunci când operațiunea eșuează. Se transmite un obiect cu următoarele proprietăți:
- errorCode:Număr. Codul de eroare ca număr zecimal pozitiv. De exemplu, codul de eroare documentat ca 0x80040333 va fi returnat ca 2147746611.
- message:Șir. Un mesaj de eroare care descrie problema.

Opțiuni

Pentru a controla ce se returnează, utilizați opțiunile de $select interogare a sistemului OData pentru $expand a regăsi datele.

Utilizați opțiunea de interogare de $select sistem pentru a limita proprietățile returnate, inclusiv o listă separată prin virgulă de nume de proprietăți. Selectarea proprietăților specifice este o practică importantă de performanță. Dacă proprietățile nu sunt specificate utilizând $select, se returnează toate proprietățile.

Utilizați opțiunea de interogare de $expand sistem pentru a controla ce date din tabelele asociate sunt returnate. Dacă includeți doar numele proprietății de navigare, primiți toate proprietățile pentru înregistrările asociate. Puteți limita proprietățile returnate pentru înregistrările asociate utilizând opțiunea $select de interogare a sistemului între paranteze după numele proprietății de navigare. Utilizați această opțiune atât pentru proprietățile de navigare cu o singură valoare , cât și pentru cele cu valoare de colecție . Pentru offline acceptăm doar opțiunea imbricată $select din $expand.

Specificați opțiunile de interogare începând cu ?. De asemenea, puteți specifica mai multe opțiuni de interogare utilizând & pentru a separa opțiunile de interogare. De exemplu:

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

Consultați Exemple pentru a vedea cum puteți defini parametrul de opțiuni pentru diverse scenarii de regăsire.

Valoare returnată

La succes, returnează o promisiune care conține un obiect JSON cu coloanele regăsite și valorile lor. Dacă înregistrarea solicitată nu există, returnează o eroare.

Exemple

Vedeți următoarele exemple:

Regăsire de bază

Regăsește numele și venitul unei înregistrări de cont cu ID-ul de înregistrare = 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
    }
);

Exemplul de mai sus afișează următorul text în consolă; este posibil să vedeți alte valori, în funcție de datele dvs.:

Retrieved values: Name: Sample Account, Revenue: 5000000

Următorul exemplu arată cum să regăsiți persoana de contact pentru o înregistrare de cont cu ID-ul de înregistrare = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Pentru înregistrarea de persoane de contact rudă, regăsim doar proprietățile contactid și nume complet .

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

Exemplul de mai sus afișează următorul text în consolă; este posibil să vedeți alte valori, în funcție de datele dvs.:

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