retrieveRecord (посилання на API клієнта)

Отримує запис таблиці.

Синтаксис

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

Параметри

Ім'я Тип Обов'язковий Опис
entityLogicalName String Так Логічне ім'я таблиці запису, який потрібно отримати. Наприклад: account.
id String Так GUID запису таблиці, який потрібно отримати.
options String Ні Параметри системного запиту OData для керування поверненням. Див . параметри
successCallback Function Ні Функція для виклику при отриманні запису. Об'єкт JSON із отриманими властивостями та значеннями, переданими до функції.
errorCallback Function Ні Функція для виклику, коли операція не вдається. Передано об'єкт із такими властивостями:
- errorCode:Число. Код помилки як додатне десяткове число. Наприклад, код помилки, задокументований як 0x80040333 , буде повернуто як 2147746611.
- message:Рядок. Повідомлення про помилку з описом проблеми.

Параметри

Щоб керувати поверненням даних, скористайтеся параметрами системного $select запиту OData та $expand OData, щоб отримати дані.

Використовуйте параметр системного $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. Для пов'язаного запису контакту ми отримуємо лише властивості contactid і 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
    }
);

У наведеному вище прикладі на консолі відображається наведений нижче текст; можуть відображатися інші значення залежно від даних:

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