118.18. 使用 Composite SObject Collections
SObject Collections API 在一个请求中对多个记录执行操作。使用 sObject Collections 来减少客户端和服务器之间的往返次数。整个请求将计入您的 API 限值的单一调用中。此资源在 API 版本 42.0 及更高版本中提供。为这些操作提供的 SObject
记录(也称为 DTOs)必须是 AbstractDescribedSObjectBase
的子类实例。有关生成这些 DTO 类的信息,请参阅 Maven 插件部分。这些操作序列化将 DTOs 提供给 JSON。
118.18.1. compositeRetrieveSObjectCollections 复制链接链接已复制到粘贴板!
检索同一对象类型的一个或多个记录。
参数 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
ids | 字符串或以逗号分隔的字符串列表 | 要返回的对象的一个或多个 ID 列表。所有 ID 必须属于相同的对象类型。 | x | |
fields | 字符串或以逗号分隔的字符串列表 | 响应中包含的字段列表。您指定的字段名称必须有效,且每个字段必须具有读取权限。 | x | |
sObjectName | 字符串 |
SObject 的类型,如 | x | |
sObjectClass | 字符串 | 用于取消响应的 DTO 类的完全限定类名称。 |
如果 |
118.18.2. compositeCreateSObjectCollections 复制链接链接已复制到粘贴板!
添加最多 200 记录,返回 SaveSObjectResult 对象列表。支持混合 SObject 类型。
参数 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
请求正文 |
| 要创建的 SObjects 列表 | x | |
allOrNone | 布尔值 | 指明是否在创建任何对象失败时回滚整个请求(true),或继续在请求中独立创建其他对象。 | false |
118.18.3. compositeUpdateSObjectCollections 复制链接链接已复制到粘贴板!
更新最多 200 记录,返回 SaveSObjectResult 对象列表。支持混合 SObject 类型。
参数 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
请求正文 |
| 要更新的 SObjects 列表 | x | |
allOrNone | 布尔值 | 指明在更新任何对象失败时是否回滚整个请求(true),或继续对请求中其他对象的独立更新。 | false |
118.18.4. compositeUpsertSObjectCollections 复制链接链接已复制到粘贴板!
根据外部 ID 字段创建或更新(upsert)最多 200 记录,返回 UpsertSObjectResult 对象列表。不支持混合 SObject 类型。
参数 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
请求正文 |
| 要 upsert 的 SObjects 列表 | x | |
allOrNone | 布尔值 | 指明当任何对象的 upsert 失败(true)或继续在请求中其他对象的独立 upsert 时,是否回滚整个请求。 | false | |
sObjectName | 字符串 |
SObject 的类型,如 | x | |
sObjectIdName | 字符串 | 外部 ID 字段的名称 | x |
118.18.5. compositeDeleteSObjectCollections 复制链接链接已复制到粘贴板!
删除最多 200 记录,返回 DeleteSObjectResult 对象列表。支持混合 SObject 类型。
参数 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
| 字符串或以逗号分隔的字符串列表 | 要删除的对象最多 200 个 ID 的列表。 | x | |
| 布尔值 | 指明在删除任何对象失败时是否回滚整个请求(true),或者继续独立删除请求中的其他对象。 | false |