updateRecord (довідник з API клієнта)

Оновлення запису таблиці.

Синтаксис

Xrm.WebApi.updateRecord(entityLogicalName, id, data).then(successCallback, errorCallback);

Параметри

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

Повернуте значення

Після успішного виконання повертає об'єкт обіцянки successCallback з такими властивостями:

Ім'я Тип Опис
entityType String Логічне ім'я таблиці запису.
id String GUID запису.

Приклади

У цих прикладах використовуються деякі об'єкти запиту, як показано в статті Оновлення та видалення рядків таблиці за допомогою веб-інтерфейсу API , щоб визначити об'єкт даних для оновлення запису таблиці.

Example Демонструє Приклад веб-інтерфейсу API
Базове оновлення Оновлення значень стовпців у наявному записі облікового запису. Базове оновлення
Оновлення зв'язків із пов'язаними таблицями Як змінити основний контакт облікового запису за допомогою @odata.bind. Зв'язування з однозначної властивістю навігації
Оновлення зв'язків із пов'язаними таблицями типу Activity Як пов'язати завдання з потенційною угодою або встановити його підстановку "Стосовно" з обліковим записом. Зв'язування з однозначної властивістю навігації
Оновлення зв'язків для властивостей навігації з колекцією Зв'язування та роз'єднання пов'язаних записів за допомогою Xrm.WebApi.online.execute. Додавання запису до колекції та видалення запису з колекції

Приклад базового оновлення

Оновлено наявний запис облікового запису з ідентифікатором запису = 5531d753-95af-e711-a94e-000d3a11e605.

// define the data to update a record
var data =
    {
        "name": "Updated Sample Account ",
        "creditonhold": true,
        "address1_latitude": 47.639583,
        "description": "This is the updated description of the sample account",
        "revenue": 6000000,
        "accountcategorycode": 2
    }
// update the record
Xrm.WebApi.updateRecord("account", "5531d753-95af-e711-a94e-000d3a11e605", data).then(
    function success(result) {
        console.log("Account updated");
        // perform operations on record update
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Щоб оновити зв'язок із пов'язаними записами таблиці (підстановками), установіть значення однозначних властивостей навігації за допомогою @odata.bind зауваження, яке вказує на інший запис.

Ось приклад коду:

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

// define the data to update a record
var data =
    {
        "primarycontactid@odata.bind": "/contacts(61a0e5b9-88df-e311-b8e5-6c3be5a8b200)"
    }
// update the record
Xrm.WebApi.updateRecord("account", "5531d753-95af-e711-a94e-000d3a11e605", data).then(
    function success(result) {
        console.log("Account updated");
        // perform operations on record update
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Застарілий метод для сценарію роботи в автономному режимі для мобільних пристроїв

Нотатка

Замість @odata.bind додавання приміток у попередньому прикладі застарілий об'єкт підстановки з властивостями з урахуванням регістра (logicalname і id) все ще підтримується для наявних настройок. Однак використовувати зауваження рекомендовано як для онлайнових @odata.bind , так і для автономних сценаріїв, а не для використання цього застарілого об'єкта.

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

// define the data to update a record
var data =
    {
        "primarycontactid":
        {
            "logicalname": "contact",
            "id": "61a0e5b9-88df-e311-b8e5-6c3be5a8b200"
        }
    }
// update the record
Xrm.WebApi.offline.updateRecord("account", "5531d753-95af-e711-a94e-000d3a11e605", data).then(
    function success(result) {
        console.log("Account updated");
        // perform operations on record update
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Щоб оновити зв'язки з пов'язаними таблицями типу Activity, установіть значення однозначних властивостей навігації за допомогою @odata.bind зауваження, яке вказує на інший запис.

Оновлення пов'язаного стовпця потенційної угоди для завдання

// define the data to update a record
var data =
    {
        "new_relatedopportunities_task@odata.bind": "/opportunities(61a0e5b9-88df-e311-b8e5-6c3be5a8b200)"
    }
// update the record
Xrm.WebApi.updateRecord("task", "5531d753-95af-e711-a94e-000d3a11e605", data).then(
    function success(result) {
        console.log("Task updated");
        // perform operations on record update
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Оновлення стовпця "Стосується" завдання

// define the data to update a record
var data =
   {
       "regardingobjectid_account_task@odata.bind": "/accounts(61a0e5b9-88df-e311-b8e5-6c3be5a8b200)"
   }
// update the record
Xrm.WebApi.updateRecord("task", "5531d753-95af-e711-a94e-000d3a11e605", data).then(
   function success(result) {
       console.log("Task updated");
       // perform operations on record update
   },
   function (error) {
       console.log(error.message);
       // handle error conditions
   }
);

Приклад оновлення зв'язків для властивостей навігації з колекцією

Використовуйте API Xrm.WebApi.online.execute , щоб пов'язувати та роз'єднувати властивості навігації з колекцією. Ця функція не підтримується для мобільних автономних сценаріїв.

Xrm.WebApi

  • Востаннє оновлено: