Freigeben über


retrieveRecord (JavaScript API-Referenz) für Dynamics 365-Kanalintegrationsframework 1.0

Ruft einen Entitätsdatensatz ab.

Syntax

Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Parameter

Name des Dataflows Typ Erforderlich Beschreibung
entityLogicalName Zeichenfolge Ja Der logische Entitätsname des Datensatzes, der abgerufen werden soll. Zum Beispiel: "Konto".
id Zeichenfolge Ja GUID des Entitätsdatensatzes, den Sie abrufen möchten.
Optionen Zeichenfolge Keine

OData-Systemabfrageoptionen $select und $expand-Abfragen, um die 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. Dies ist eine wichtige Methode für die Leistungssteigerung. Wenn Eigenschaften nicht mithilfe von $selectangegeben wurden, werden alle Eigenschaften zurückgegeben.
  • Verwenden Sie die $expand-Systemabfrageoption, um zu steuern, welche Daten von den verbundenen Entitäten 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 verknüpfte Datensätze mithilfe der $select-Systemabfrageoption in Klammern nach dem Namen der Navigationseigenschaft zurückgegeben werden. Verwenden Sie dieses für einzelwertige und sammlungswertige Navigationseigenschaften.

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

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

Eine Funktion zum Aufrufen, wenn ein Datensatz abgerufen wird.

errorCallback Funktion Nein Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug.

Rückgabewert

Gibt bei Erfolg eine Zusage zurück, die eine Zeichenfolge mit den abgerufenen Attributen und deren Werten enthält.

Beispiele

Dieser Beispielcode ruft den Namen und die Telefonnummer eines Kontaktdatensatzes mit der ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 ab.

// retrieve contact record
var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
var entityLogicalName = "contact";
Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, "?$select=fullname,telephone1").then(
    function success(result) {
      res=JSON.parse(result);
        console.log(`Retrieved values: Full Name: ${res.fullname}, Telephone Number: ${res.telephone1}`);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);