retrieveRecord (Клиент API сілтемесі)

Кесте жазбасын қайтару.

Синтаксис

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

РаT�

Аты Түр Талап етіледі Сипаттамасы
entityLogicalName String Иә Қалпына келтіргіңіз келетін жазбаның кестенің логикалық атауы. Мысалы: account.
id String Иә Қалпына келтіргіңіз келетін кесте жазбасының GUID.
options String Жоқ Қайтарылған нәрсені басқару үшін OData жүйелік сұрау параметрлері. Параметрлерді қарау
successCallback Function Жоқ Жазба алынған кезде қоңырау шалуға арналған функция. Функцияға берілетін қалпына келтірілген қасиеттері мен мәндері бар JSON нысаны.
errorCallback Function Жоқ Операция істен шыққанда қоңырау шалу функциясы. Келесі қасиеттері бар нысан беріледі:
- errorCode: Сан. Қате коды оң ондық сан ретінде. Мысалы, құжатталған 0x80040333 қате коды ретінде 2147746611қайтарылады.
- message: Жол. Ақауды сипаттайтын қате туралы хабар.

Параметрлер

Қайтарылатын нәрсені басқару үшін деректерді алу үшін және $expand OData жүйелік сұрау параметрлерін пайдаланыңыз$select.

Үтірмен бөлінген қасиеттер тізімін қосу арқылы қайтарылған қасиеттерді шектеу үшін жүйелік сұрау параметрін пайдаланыңыз $select . Белгілі бір қасиеттерді таңдау - бұл маңызды өнімділіктің ең жақсы әдісі. Егер сипаттар пайдалану $selectарқылы көрсетілмесе, барлық қасиеттер қайтарылады.

Байланысты кестелерден қайтарылған деректерді басқару үшін жүйелік сұрау параметрін пайдаланыңыз $expand . Егер шарлау сипатының атауын ғана қоссаңыз, байланысты жазбалар үшін барлық сипаттарды аласыз. Шарлау сипаты атауынан кейін жақшадағы жүйелік сұрау параметрін пайдаланып $select байланысты жазбалар үшін қайтарылған сипаттарды шектеуге болады. Мұны бір мәнді және жиындық мәнді шарлау сипаттары үшін пайдаланыңыз. Офлайн режимінде біз тек $select .$expand

Сұрау параметрлерін келесіден бастап ?көрсетіңіз. Сондай-ақ, сұрау параметрлерін бөлу үшін пайдалану & арқылы бірнеше сұрау параметрлерін көрсетуге болады. Мысалы:

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

Әр түрлі қалпына келтіру сценарийлері үшін параметрлер параметрін қалай анықтауға болатындығын көру үшін Мысалдарды қараңыз.

Қайтаратын мән

Сәтті болған жағдайда, алынған бағандар мен олардың мәндері бар JSON нысаны бар уәдені қайтарады. Егер сұралған жазба болмаса, қатені қайтарады.

Мысалдар

Келесі мысалдарды қараңыз:

Негізгі алу

Жазба идентификаторы = 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
    }
);

Жоғарыдағы мысал консольде келесі мәтінді көрсетеді; Деректеріңізге байланысты басқа мәндерді көре аласыз:

Retrieved values: Name: Sample Account, Revenue: 5000000

Келесі мысалда = a8a19cdd-88df-e311-b8e5-6c3be5a8b200 жазба идентификаторы бар тіркелгі жазбасы үшін контактіні алу әдісі көрсетілген. Байланысты контакт жазбасы үшін біз тек контакт идентификаторы мен толық аты сипаттарын аламыз.

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

Жоғарыдағы мысал консольде келесі мәтінді көрсетеді; Деректеріңізге байланысты басқа мәндерді көре аласыз:

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