REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
allOrNone Parameters in Composite and Collections Requests
- If the Composite request has allOrNone set to true, then the all-or-none behavior also applies to each of the sObject Collections subrequests, overriding the value of allOrNone in the subrequests.
- If the Composite request has allOrNone set to false, then each sObject Collections subrequest behaves according to its value of allOrNone.
Consider, for example, what happens with this job where a Composite request includes two items: an sObject Collections request and a request to create a Contact. The sObject Collections request tries to create two Accounts, one of which fails because there is already an existing Account with the same information.
POST https://MyDomainName.my.salesforce.com/services/data/v64.0/composite -H "Authorization: Bearer token"
{
"allOrNone" : outerFlag,
"collateSubrequests" : false,
"compositeRequest" : [
{
"method" : "POST",
"url" : "/services/data/v64.0/composite/sobjects",
"body" : {
"allOrNone" : innerFlag,
"records" : [
{
"attributes" : { "type" : "Account" },
"Name" : "Northern Trail Outfitters",
"BillingCity" : "San Francisco"
},
{
"attributes" : { "type" : "Account" },
"Name" : "Easy Spaces",
"BillingCity" : "Calgary"
}
]
},
"referenceId" : "newAccounts"
},
{
"method" : "POST",
"url" : "/services/data/v64.0/sObject/Contact",
"body" : {
"FirstName" : "John",
"LastName" : "Smith"
},
"referenceId" : "newContact"
}
]
}The outerFlag and innerFlag parameters are either true or false, which leads to four possible cases.
Case 1: outerFlag = false, innerFlag = false
In this case, neither request has allOrNone set to true, so neither request is rolled back. One account is created and one fails.
Case 2: outerFlag = false, innerFlag = true
In this case, the inner sObject Collections request has allOrNone set to true, so it is rolled back. The outer Composite request is not rolled back.
Case 3: outerFlag = true, innerFlag = true
In this case, both requests have allOrNone set to true, so they are both rolled back.
Case 4: outerFlag = true, innerFlag = false
{
"compositeResponse" : [
{
"body" : [
{
"id" : "001R00000066cndIAA",
"success" : true,
"errors" : [ ]
},
{
"success" : false,
"errors" : [
{
"statusCode" : "DUPLICATES_DETECTED",
"message" : "Use one of these records?",
"fields" : [ ]
}
]
}
],
"httpHeaders" : { },
"httpStatusCode" : 200,
"referenceId" : "collection1"
},
{
"body" : [
{
"errorCode" : "PROCESSING_HALTED",
"message" : "The transaction was rolled back since another operation in the same transaction failed."
}
],
"httpHeaders" : { },
"httpStatusCode" : 400,
"referenceId" : "newContact"
}
]
}In this case, the inner sObject Collections request has allOrNone set to false, so it is not immediately rolled back. However, the outer Composite request has allOrNone set to true so it is rolled back, which also rolls back the inner sObject Collections request.
