REST API 開発者ガイド
jBatch リクエストボディ
Composite Batch リソースを使用して実行するサブ要求のコレクションを記述します。
Batch Collection Input
このリクエストボディには、実行するサブ要求で構成される batchRequests コレクションが含まれます。
- プロパティ
-
名前 型 説明 必須か省略可能 batchRequests Subrequest[] 実行するサブ要求のコレクション。 必須 haltOnError Boolean サブ要求が失敗した場合に、一括処理を停止するかどうかを制御します。デフォルトは、false です。 値が false で、バッチ内のサブ要求が完了しない場合、Salesforce は、バッチ内の後続のサブ要求を実行しようと試みます。
値が true で、HTTP 応答 400 番台または 500 番台のエラーが含まれるためにバッチ内のサブ要求が完了しない場合、Salesforce は実行を停止します。また、後続のサブ要求ごとに HTTP 412 状況コードと BATCH_PROCESSING_HALTED エラーメッセージを返します。/composite/batch への最上位要求は、HTTP 200 を返し、応答内の hasErrors プロパティが true に設定されます。
この設定は、サブ要求処理中にのみ適用され、最初の要求の並列化中には適用されません。Subrequest 要求データの構文エラーなど、並列化中にエラーが検出された場合、Salesforce は haltOnError の値に関わらず、以降のサブ要求の処理を中止して、HTTP 400 Bad Request エラーを返します。これが発生する一例は、サブ要求に無効な method または url 項目が含まれていた場合です。
省略可能 - ルート XML タグ
- <batch>
- JSON の例
-
1{ 2"batchRequests" : [ 3 { 4 "method" : "PATCH", 5 "url" : "v60.0/sobjects/account/001D000000K0fXOIAZ", 6 "richInput" : {"Name" : "NewName"} 7 },{ 8 "method" : "GET", 9 "url" : "v60.0/sobjects/account/001D000000K0fXOIAZ?fields=Name,BillingPostalCode" 10 }] 11}
サブ要求
サブ要求のリソース、メソッド、および付随情報が含まれます。
- プロパティ
-
名前 型 説明 必須か省略可能 binaryPartName String マルチパート要求のバイナリパートの名前。 1 つのバッチ要求で複数のバイナリパートがアップロードされると、この値が要求とバイナリパートの対応付けに使用されます。名前の競合を防止するために、バッチ要求内の各 binaryPartName プロパティには一意の値を使用します。
この値が存在する場合、binaryPartNameAlias 値も存在する必要があります。
省略可能 binaryPartNameAlias String バイナリボディパートの Content-Disposition ヘッダーの name パラメーター。リソースごとに異なる値を使用します。「Blob データを挿入または更新する」を参照してください。 この値が存在する場合、binaryPartName 値も存在する必要があります。
省略可能 method String 要求するリソースに使用するメソッド。有効なメソッドのリストは、要求するリソースに関するドキュメントを参照してください。 必須 richInput 要求の入力ボディ。 型は url プロパティに指定された要求に応じて異なります。
省略可能 url String 要求するリソース。 - URL には、サブ要求がサポートするクエリ文字列パラメーターを含めることができます。クエリ文字列は、URL 符号化されている必要があります。
- パラメーターを使用して、レスポンスボディを絞り込むことができます。
- サブ要求レベルでヘッダーを適用することはできません。
必須 - ルート XML タグ
- <request>
- JSON の例
-
1{ 2 "method" : "GET", 3 "url" : "v60.0/sobjects/account/001D000000K0fXOIAZ?fields=Name,BillingPostalCode" 4}