Udostępnij przez

retrieveRecord (dokumentacja interfejsu API języka JavaScript) dla Dynamics 365 Channel Integration Framework 1.0

Pobiera rekord encji.

Składnia

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

Parametry

Name Typ Wymagane Description
entityLogicalName (nazwa_logiczna) Sznurek Tak Nazwa logiczna encji rekordu, który chcesz pobrać. Na przykład: "konto".
id Sznurek Tak Identyfikator GUID rekordu encji, który chcesz pobrać.
options Sznurek Nie.

Opcje kwerend systemowych OData, $select i $expand, w celu pobrania danych.

  • Użyj opcji $select kwerendy systemowej, aby ograniczyć zwracane właściwości przez dołączenie rozdzielanej przecinkami listy nazw właściwości. Jest to ważne najlepsze rozwiązanie dotyczące wydajności. Jeśli właściwości nie zostaną określone przy użyciu $select, zostaną zwrócone wszystkie właściwości.
  • Użyj opcji $expand kwerendy systemowej, aby kontrolować, jakie dane z encji pokrewnych są zwracane. Jeśli dołączysz tylko nazwę właściwości nawigacji, otrzymasz wszystkie właściwości dla powiązanych rekordów. Właściwości zwracane dla rekordów pokrewnych można ograniczyć za pomocą opcji $select kwerendy systemowej w nawiasach po nazwie właściwości nawigacji. Użyj tej opcji zarówno dla właściwości nawigacji jednowartościowych , jak i kolekcji .

Opcje kwerendy określa się, zaczynając od ?. Można również określić wiele opcji zapytania, używając & polecenia do oddzielenia opcji zapytania. Przykład:

?$select=name&$expand=primarycontactid($select=contactid,fullname)
successCallback (pomyślne wywołanie zwrotne) Funkcja Nie.

Funkcja wywoływana po pobraniu rekordu.
errorOddzwanianie Funkcja Nie. Funkcja wywoływana, gdy operacja zakończy się niepowodzeniem.

Wartość zwracana

W przypadku powodzenia zwraca obietnicę zawierającą ciąg z pobranymi atrybutami i ich wartościami.

Przykłady

Ten przykładowy kod pobiera nazwę i numer telefonu rekordu kontaktu o identyfikatorze = a8a19cdd-88df-e311-b8e5-6c3be5a8b200.

// 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
    }
);
  • Last updated on