111.18. 複合 sObject コレクションの使用
sObject Collections API は、1 つのリクエストで複数のレコードに対してアクションを実行します。sObject コレクションを使用して、クライアントとサーバー間の往復回数を減らします。リクエスト全体が、API 制限に対する 1 回の呼び出しとしてカウントされます。このリソースは、API バージョン 42.0 以降で使用できます。これらの操作に提供される SObject レコード (別名 DTO) は、AbstractDescribedSObjectBase のサブクラスのインスタンスである必要があります。これらの DTO クラスの生成は、Maven プラグインのセクションを参照してください。これらの操作は、提供された DTO を JSON にシリアライズします。
111.18.1. compositeRetrieveSObjectCollections リンクのコピーリンクがクリップボードにコピーされました!
同じオブジェクトタイプの 1 つ以上のレコードを取得します。
| パラメーター | 型 | 説明 | デフォルト | 必須 |
|---|---|---|---|---|
| ids | 文字列またはコンマ区切り文字列のリスト | 返されるオブジェクトの 1 つ以上の ID のリスト。すべての ID は同じオブジェクトタイプに属している必要があります。 | x | |
| fields | 文字列またはコンマ区切り文字列のリスト | 応答に含めるフィールドのリスト。指定するフィールド名は有効である必要があり、各フィールドに対する読み取りレベルの権限が必要です。 | x | |
| sObjectName | String |
| x | |
| sObjectClass | String | レスポンスの逆シリアル化に使用する DTO クラスの完全修飾クラス名 |
|
111.18.2. compositeCreateSObjectCollections リンクのコピーリンクがクリップボードにコピーされました!
最大 200 レコードを追加して、SaveSObjectResult オブジェクトのリストを返します。混合 SObject タイプがサポートされています。
| パラメーター | 型 | 説明 | デフォルト | 必須 |
|---|---|---|---|---|
| 要求のボディー |
| 作成する SObject のリスト | x | |
| allOrNone | boolean | いずれかのオブジェクトの作成が失敗したときにリクエスト全体をロールバックするか (true)、リクエスト内の他のオブジェクトの独立した作成を続行するかを示します。 | false |
111.18.3. compositeUpdateSObjectCollections リンクのコピーリンクがクリップボードにコピーされました!
SaveSObjectResult オブジェクトのリストを返し、最大 200 件のレコードを更新します。混合 SObject タイプがサポートされています。
| パラメーター | 型 | 説明 | デフォルト | 必須 |
|---|---|---|---|---|
| 要求のボディー |
| 更新する SObject のリスト | x | |
| allOrNone | boolean | いずれかのオブジェクトの更新が失敗した場合 (true)、要求全体をロールバックするか、要求内の他のオブジェクトの独立した更新を続行するかを示します。 | false |
111.18.4. compositeUpsertSObjectCollections リンクのコピーリンクがクリップボードにコピーされました!
UpsertSObjectResult オブジェクトのリストを返し、外部 ID フィールドに基づいて最大 200 のレコードを作成または更新 (アップサート) します。混合 SObject タイプはサポートされていません。
| パラメーター | 型 | 説明 | デフォルト | 必須 |
|---|---|---|---|---|
| 要求のボディー |
| アップサートする SObject のリスト | x | |
| allOrNone | boolean | いずれかのオブジェクトの upsert が失敗したときにリクエスト全体をロールバックするか (true)、リクエスト内の他のオブジェクトの独立した upsert を続行するかを示します。 | false | |
| sObjectName | String |
| x | |
| sObjectIdName | String | 外部 ID フィールドの名前 | x |
111.18.5. compositeDeleteSObjectCollections リンクのコピーリンクがクリップボードにコピーされました!
最大 200 件のレコードを削除し、DeleteSObjectResult オブジェクトのリストを返します。混合 SObject タイプがサポートされています。
| パラメーター | 型 | 説明 | デフォルト | 必須 |
|---|---|---|---|---|
|
| 文字列またはコンマ区切り文字列のリスト | 削除するオブジェクトの最大 200 ID のリスト。 | x | |
|
| boolean | いずれかのオブジェクトの削除が失敗した場合にリクエスト全体をロールバックするか (true)、リクエスト内の他のオブジェクトの個別の削除を続行するかを示します。 | false |