Force.com REST API 開発者ガイド
jComposite
一連の REST API 要求を単一のコールで実行します。1 つの要求の出力を、後続の要求の入力として使用できます。要求のレスポンスボディと HTTP 状況は、1 つのレスポンスボディで返されます。要求全体が API の制限への単一のコールとしてカウントされます。
Composite コールの要求はサブ要求と呼ばれます。サブ要求はすべて同じユーザのコンテキスト内で実行されます。サブ要求のボディで、サブ要求のレスポンスに対応付けられる参照 ID を指定します。その後、JavaScript ライクな参照表記を使用して、後のサブ要求の url または body 項目でこの ID を参照できます。
たとえば、次の Composite リクエストボディには 2 つのサブ要求が含まれます。最初のサブ要求は取引先を作成し、出力を refAccount として指定します。2 番目のサブ要求は、サブ要求のボディで refAccount を参照して、新しい取引先を親とする取引先責任者を作成します。
サブ要求のエラーによって Composite リクエスト全体がロールバックされるか、または連動するサブ要求のみがロールバックされるかを指定できます。サブ要求ごとにヘッダーを指定することもできます。
Composite は次のリソースでサポートされます。
- すべての sObject リソース (vXX.X/sobjects/)
- Query リソース (vXX.X/query/?q=soql)
- QueryAll リソース (vXX.X/queryAll/?q=soql)
- URI
- /vXX.X/composite
- 形式
- JSON
- HTTP メソッド
- GET (使用できる他の Composite リソースをリスト)、POST
- 認証
- Authorization: Bearer token
- パラメータ
- 不要
- リクエストボディ
- Composite リクエストボディ
- レスポンスボディ
- Composite レスポンスボディ
- 例
- Composite リソースの使用例は、「単一の API コールでの連動要求の実行」および「取引先の更新、取引先責任者の作成、および連結オブジェクトとのリンク」を参照してください。