Freigeben über

retrieveRecord (Client-API-Referenz)

  • Artikel

Ruft einen Tabellendatensatz ab.

Syntax

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

Parameter

Name typ Erforderlich Eigenschaft
entityLogicalName String Ja Den logischen Tabellennamen des Datensatzes, den Sie abrufen wollen. Beispiel: account.
id Zeichenfolge Ja GUID des Tabellendatensatzes, den Sie abrufen wollen.
options Zeichenfolge Nein Abfrageoptionen des OData-Systems, um zu steuern, was zurückgegeben wird. Siehe Optionen
successCallback Funktion Nein Eine Funktion zum Aufrufen, wenn ein Datensatz abgerufen wird. Ein JSON-Objekt mit den abgerufen Eigenschaften und Werten wird an die Funktion übergeben.
errorCallback Funktion Nein Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug.

Optionen

Um zu steuern, was zurückgegeben wird, verwenden Sie die OData-Systemabfrageoptionen $select und $expand, um Ihre Daten abzurufen.

Verwenden Sie die $select Systemabfrageoption, um die Eigenschaften zu begrenzen, die zurückgegeben werden, indem Sie eine kommagetrennte Liste von Eigenschaftsnamen einschließen. Die Auswahl bestimmter Eigenschaften ist eine wichtige Best Practice für die Leistung. Wenn Eigenschaften nicht mithilfe von $select angegeben wurden, werden alle Eigenschaften zurückgegeben.

Verwenden Sie die $expand-Systemabfrageoption, um zu steuern, welche Daten von den verbundenen Tabellen zurückgegeben werden. Wenn Sie nur den Namen der Navigationseigenschaft einschließen, rufen Sie alle Eigenschaften für in Verbindung stehende Datensätze ab. Sie können die Eigenschaften begrenzen, die für in Verbindung stehende Aufzeichnungen unter Verwendung der Systemabfrageoption $select in Klammern nach dem Namen der Navigationseigenschaft zurückgegeben werden. Verwenden Sie dieses für einzelwertige und sammlungswertige Navigationseigenschaften. Für Offline unterstützen wir nur die verschachtelte $select-Option innerhalb von $expand.

Sie geben die Abfrageoptionen beginnend mit ?an. Um mehrere Abfrageoptionen zu definieren, verwenden Sie &, um die Abfrageoptionen zu trennen. Zum Beispiel:

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

Siehe Beispiele weiter unten in diesem Thema, um zu sehen, wie Sie den Optionsparameter für den Abruf mehrerer Szenarios definieren können.

Rückgabewert

Bei Erfolg wird ein Versprechenmit einem JSON-Objekt zurückgegeben, mit den abgerufenen Spalten und den dazugehörigen Werten. Wenn der angeforderte Datensatz nicht vorhanden ist, wird ein Fehler zurückgegeben.

Beispiele

Siehe folgende Beispiele:

Grundlegendes Abrufen

Ruft den Namen und den Umsatz eines Firmendatensatzes mit der Datensatz-ID = 5531d753-95af-e711-a94e-000d3a11e605 ab.

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

Im oben aufgeführten Beispiel erscheint folgender Text auf der Konsole. Sie sehen ggf. je nach Ihren Daten weitere Werte:

Retrieved values: Name: Sample Account, Revenue: 5000000

Im folgenden Beispiel wird gezeigt, wie der Kontakt für einen Firmendatensatz mit der Datensatz-ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 abgerufen wird. Für den in Verbindung stehenden Kontaktdatensatz rufen wir nur die Eigenschaften contactid und fullname ab.

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

Im oben aufgeführten Beispiel erscheint folgender Text auf der Konsole. Sie sehen ggf. je nach Ihren Daten weitere Werte:

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

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi