この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Composite

一連の REST API 要求を単一のコールで実行します。1 つの要求の出力を、後続の要求の入力として使用できます。要求のレスポンスボディと HTTP 状況は、1 つのレスポンスボディで返されます。一連の要求全体が API の制限に単一のコールとして計上されます。

Composite コールの要求はサブ要求と呼ばれます。サブ要求はすべて同じユーザのコンテキスト内で実行されます。サブ要求のボディで、サブ要求のレスポンスに対応付けられる参照 ID を指定します。その後、JavaScript ライクな参照表記を使用して、後のサブ要求の url または body 項目でこの ID を参照できます。

たとえば、次の Composite リクエストボディには 2 つのサブ要求が含まれます。最初のサブ要求は取引先を作成し、出力を refAccount として指定します。2 番目のサブ要求は、サブ要求のボディで refAccount を参照して、新しい取引先を親とする取引先責任者を作成します。

1{
2"compositeRequest" : [{
3  "method" : "POST",
4  "url" : "/services/data/v53.0/sobjects/Account",
5  "referenceId" : "refAccount",
6  "body" : { "Name" : "Sample Account" }
7  },{
8  "method" : "POST",
9  "url" : "/services/data/v53.0/sobjects/Contact",
10  "referenceId" : "refContact",
11  "body" : { 
12    "LastName" : "Sample Contact",
13    "AccountId" : "@{refAccount.id}"
14    }
15  }]
16}

サブ要求のエラーによって Composite リクエスト全体がロールバックされるか、または連動するサブ要求のみがロールバックされるかを指定できます。サブ要求ごとにヘッダーを指定することもできます。

Composite は次のリソースでサポートされます。

sObject Rows by External ID を含むすべての sObject リソース (vXX.X/sobjects/)
Query リソース (vXX.X/query/?q=soql)
QueryAll リソース (vXX.X/queryAll/?q=soql)
sObject Collections リソース (vXX.X/composite/sobjects)。API バージョン 43.0 以降で使用できます。

1 回のコールに最大 25 個のサブ要求を含めることができます。これらのサブ要求のうち最大 5 個を sObject コレクションまたはクエリ操作とすることができます (「Query」要求や「QueryAll」要求など)。

メモ

URI: /services/data/vXX.X/composite
形式: JSON
HTTP メソッド: GET (使用できる他の Composite リソースをリスト)、POST
認証: Authorization: Bearer token
パラメータ: 不要
リクエストボディ: Composite リクエストボディ
レスポンスボディ: Composite レスポンスボディ
例: Composite リソースの使用例は「単一の API コールでの連動要求の実行」および「取引先の更新、取引先責任者の作成、および連結オブジェクトとのリンク」を参照してください。

REST API 開発者ガイド

Composite