Delen via

retrieveRecord (client-API-verwijzing)

Hiermee haalt u een tabelrecord op.

Syntaxis

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

Parameterwaarden

Naam Typologie Verplicht Description
entityLogicalName Snaar / Touwtje Yes De logische tabelnaam van de record die u wilt ophalen. Voorbeeld: account.
id Snaar / Touwtje Yes GUID van de tabelrecord die u wilt ophalen.
options Snaar / Touwtje Nee. OData-systeemqueryopties om te bepalen wat er wordt geretourneerd. Opties weergeven
successCallback Functie Nee. Een functie om aan te roepen wanneer een record wordt opgehaald. Een JSON-object met de opgehaalde eigenschappen en waarden die aan de functie zijn doorgegeven.
errorCallback Functie Nee. Een functie om aan te roepen wanneer de bewerking mislukt. Er wordt een object met de volgende eigenschappen doorgegeven:
- errorCode:Getal. De foutcode als een positief decimaal getal. De foutcode die wordt beschreven zoals 0x80040333 wordt geretourneerd als 2147746611.
- message:Snaar. Een foutmelding die het probleem beschrijft.

Options

Als u wilt bepalen wat er wordt geretourneerd, gebruikt u de queryopties van $expand het $select OData-systeem om uw gegevens op te halen.

Gebruik de $select systeemqueryoptie om de eigenschappen te beperken die worden geretourneerd door een door komma's gescheiden lijst met eigenschapsnamen op te geven. Het selecteren van specifieke eigenschappen is een belangrijke best practice voor prestaties. Als er geen eigenschappen worden opgegeven met behulp van $select, worden alle eigenschappen geretourneerd.

Gebruik de $expand systeemqueryoptie om te bepalen welke gegevens uit gerelateerde tabellen worden geretourneerd. Als u alleen de naam van de navigatie-eigenschap opneemt, ontvangt u alle eigenschappen voor gerelateerde records. U kunt de eigenschappen die worden geretourneerd voor gerelateerde records beperken met behulp van de $select optie systeemquery tussen haakjes na de naam van de navigatie-eigenschap. Gebruik dit voor navigatie-eigenschappen met één of meteen verzamelingswaarde . Voor offline ondersteunen we alleen geneste $select opties in de $expand.

U geeft de queryopties op die beginnen met ?. U kunt ook meerdere queryopties opgeven door de queryopties te scheiden & . Voorbeeld:

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

Zie Voorbeelden om te zien hoe u de parameter opties voor verschillende ophaalscenario's kunt definiëren.

Retourwaarde

Retourneert bij succes een belofte met een JSON-object met de opgehaalde kolommen en de bijbehorende waarden. Als de aangevraagde record niet bestaat, wordt er een fout geretourneerd.

Voorbeelden

Zie de volgende voorbeelden:

Basis ophalen

Haalt de naam en omzet van een accountrecord op met record-id = 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
    }
);

In het bovenstaande voorbeeld wordt de volgende tekst weergegeven in uw console; Mogelijk ziet u andere waarden, afhankelijk van uw gegevens:

Retrieved values: Name: Sample Account, Revenue: 5000000

In het volgende voorbeeld ziet u hoe u de contactpersoon voor een accountrecord met record-id = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 ophaalt. Voor de gerelateerde contactpersoonrecord halen we alleen de eigenschappen contactid en fullname op.

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

In het bovenstaande voorbeeld wordt de volgende tekst weergegeven in uw console; Mogelijk ziet u andere waarden, afhankelijk van uw gegevens:

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