次の方法で共有

Xrm.WebApi.online.executeMultiple (クライアント API 参照)

  • [アーティクル]

アクション、関数、または CRUD 操作のコレクションを実行します。

注意

このメソッドは、オンライン モードでのみサポートされます (Xrm.WebApi.online)。

トランザクション内で複数の要求を実行する場合、変更セットをパラメーターとしてこのメソッドに渡す必要があります。 変更セット はトランザクションで実行されるオペレーションのコレクションを示します。 また、個々の要求および変更セットを一緒にパラメーターとしてこのメソッドに渡すことができます。

注意

  • 読み取りオペレーション (取得、複数取得、および Web API 関数) を変更セットの一部として含めることはできません。これは OData v4 仕様です。
  • 要求には最大 1000 個の別々要求を含めることができるが、他のバッチを含めることはできません。 詳細: バッチ操作を実行する。

構文

複数の要求を実行する:

var requests = [req1, req2, req3];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

トランザクション内で複数の要求を実行する:

この場合、req1、req2、および req3 がトランザクション内で実行されます。

var changeSet = [req1, req2, req3];
var requests = [changeSet];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

トランザクション内で個々の要求および複数の要求の混在を実行:

この場合、req1、req2、および req3 はトランザクションで実行されますが、req4 および req5 は個別に実行されます。

var changeSet = [req1, req2, req3];
var requests = [req4, req5, changeset];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Parameters

件名 タイプ Required Description
requests オブジェクトの配列 はい 以下のいずれかの種類の配列:

各オブジェクトが、Web API エンドポイントに対して実行するアクション、関数、または CRUD 要求である オブジェクト。 各オブジェクトは、実行するアクション、関数、または CRUD 要求のメタデータを定義することができる、getMetadata メソッド を公開します。 execute メソッドは、このタイプのパラメーターを受け入れます。

変更セット内の各オブジェクトが上記のように定義された 変更セット (オブジェクトの配列)。 この場合、変更セットで指定されたすべての要求オブジェクトがトランザクションで実行されます。

詳細については、構文セクション の前半の要求例を参照してください。
successCallback Function いいえ オペレーションが正常に実行されたときにコールされる関数。 応答オブジェクトの配列が関数に渡されます。 戻り値 を見る
errorCallback Function いいえ 処理が失敗したときに呼び出す関数。

戻り値

成功すると、オブジェクトのアレイを successCallback を含む約束を返します。 オブジェクトには次のプロパティがあります。

件名 タイプ Required Description
json 約束 いいえ JSON 形式の応答本文。
text 約束 いいえ プレーンテキスト形式の応答本文。
headers Object はい 応答ヘッダー。
ok ブール型 はい 要求が成功したかどうかを示します。
status 回数 はい 応答ステータス コードの数値です。 例: 200
statusText String はい 応答ステータス コードの説明。 例: OK
type String はい 応答の種類。 値は以下の通りです: 空欄の文字列 (規定)、arraybuffer、blob、document、json、および text。
url String はい Web API エンドポイントに送信された、アクション、関数、または CRUD 要求の要求 URL。

Xrm.WebApi

注意

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

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