retrieveRecord (dokumentacja interfejsu API klienta)

Pobiera rekord tabeli.

Składnia

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

Parametry

Opcje

Aby kontrolować zwracane dane, użyj $select opcji zapytania systemowego OData i $expand , aby pobrać dane.

$select Użyj opcji zapytania systemowego, aby ograniczyć właściwości zwracane przez dołączenie rozdzielanej przecinkami listy nazw właściwości. Wybór określonych właściwości jest ważnym najlepszym rozwiązaniem w zakresie wydajności. Jeśli właściwości nie są określone przy użyciu $selectmetody , zwracane są wszystkie właściwości.

Użyj opcji zapytania systemowego $expand , aby kontrolować, jakie dane z powiązanych tabel są zwracane. Jeśli po prostu dołączysz nazwę właściwości nawigacji, otrzymasz wszystkie właściwości powiązanych rekordów. Właściwości zwracane dla powiązanych rekordów można ograniczyć przy użyciu $select opcji zapytania systemowego 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 . W przypadku trybu offline obsługujemy tylko opcję zagnieżdżonych $select wewnątrz elementu $expand.

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)

Zobacz Przykłady , aby zobaczyć, jak można zdefiniować parametr opcji dla różnych scenariuszy pobierania.

Wartość zwracana

Po powodzeniu zwraca obietnicę zawierającą obiekt JSON z pobranymi kolumnami i ich wartościami. Jeśli żądany rekord nie istnieje, zwraca błąd.

Przykłady

Zobacz następujące przykłady:

• Pobieranie podstawowe
• Pobieranie powiązanych tabel dla wystąpienia tabeli przez rozwinięcie właściwości nawigacji z jedną wartością

Pobieranie podstawowe

Pobiera nazwę i przychód rekordu konta z identyfikatorem rekordu = 5531d753-95af-e711-a94e-000d3a1e605.

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

W powyższym przykładzie zostanie wyświetlony następujący tekst w konsoli użytkownika; Inne wartości mogą być widoczne w zależności od danych:

Retrieved values: Name: Sample Account, Revenue: 5000000

Pobieranie powiązanych tabel dla wystąpienia tabeli przez rozwinięcie właściwości nawigacji z jedną wartością

W poniższym przykładzie pokazano, jak pobrać kontakt dla rekordu konta z identyfikatorem rekordu = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. W przypadku powiązanego rekordu kontaktu pobieramy tylko właściwości contactid i fullname .

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

W powyższym przykładzie zostanie wyświetlony następujący tekst w konsoli użytkownika; Inne wartości mogą być widoczne w zależności od danych:

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

Powiązane artykuły

Xrm.WebApi.retrieveMultipleRecords
Xrm.WebApi