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