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