updateRecord (Client API 参照)

  • [アーティクル]

テーブル レコードを更新します。

構文

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

Parameters

件名 タイプ Required Description
entityLogicalName String 可 更新するレコードのテーブル論理名。 例: account。
id String 可 更新するテーブル レコードの GUID。
data Object 可 key: value ペアを含む JSON 文字列では、key はエンティティのプロパティであり、テーブルと value は、更新するプロパティの値です。
さまざまな更新のシナリオ向けに data オブジェクトを定義する方法については、このトピックの以降の 例 を参照してください。
successCallback Function No レコードを更新した場合に呼び出す関数。 戻り値 を見る
errorCallback Function No 処理が失敗したときに呼び出す関数。 次のプロパティを持つオブジェクトが渡されます。
- errorCode : 番号。 エラー コード。
- message : 文字列。 問題を示すエラー メッセージが表示されます。

戻り値

成功すると、Promiseオブジェクトを successCallback 次のプロパティを使用します。

件名 タイプ Description
entityType String レコードのテーブル論理名です。
id String レコードの GUID。

使用例

これらの例では、Web APIをしたテーブル行の更新および削除 で示した要求オブジェクトの一部を使用して、テーブル レコードを更新するためのデータ オブジェクトを定義しています。

基本的な更新

レコード ID = 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) を持つ廃止された lookup オブジェクトを既存のカスタマイズに使用することも引き続きサポートされます。 ただし、この廃止されたオブジェクトを使用する代わりに、オンライン シナリオとオフライン シナリオの両方で @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
   }
);

コレクション値のナビゲーション プロパティの関連付けを更新する

Xrm.WebApi.online.execute API を使用して、コレクション値のナビゲーション プロパティを関連付けたり関連付けを解除したりできます。 これは、モバイル オフライン シナリオではサポートされていません。

Xrm.WebApi

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。