REST API Developer Guide
jNewer Version Available
Composite Response Body
Describes the result of a Composite
request.
Composite Results
- Properties
-
Name Type Description compositeResponse Composite Subrequest Result[] Collection of subrequest results - JSON example
-
1{ 2 "compositeResponse" : [{ 3 Composite Subrequest Result 4 },{ 5 Composite Subrequest Result 6 },{ 7 Composite Subrequest Result 8 }] 9}
Composite Subrequest Result
- Properties
-
Name Type Description body The type depends on the response type of the subrequest. The response body of this subrequest. See the documentation for the subrequest resource for more information.
If the subrequest returns an error, the body includes the error code and message. For more details on error responses, see Status Codes and Error Responses
httpHeaders Map<String, String> Response headers and their values for this subrequest. The Composite resource doesn’t support the Content-Length header, so subrequest responses don’t include this header and neither does the top-level response. httpStatusCode Integer An HTTP status code for this subrequest. If allOrNone is set to true in the composite request and a subrequest returns an error, all other subrequests return the 400 HTTP status code. referenceID String The reference ID specified in the subrequest. This property lets you easily associate subrequests with their results. - JSON example
-
The following example shows the response for a subrequest that successfully created an Account:
1{ 2 "body" : { 3 "id" : "001R00000033I6AIAU", 4 "success" : true, 5 "errors" : [ ] 6 }, 7 "httpHeaders" : { 8 "Location" : "/services/data/v38.0/sobjects/Account/001R00000033I6AIAU" 9 }, 10 "httpStatusCode" : 201, 11 "referenceId" : "refAccount" 12}The following example shows the response for a subrequest that had an error while trying to create a Contact:
1{ 2 "body" : [ { 3 "message" : "Email: invalid email address: Not a real email address", 4 "errorCode" : "INVALID_EMAIL_ADDRESS", 5 "fields" : [ "Email" ] 6 } ], 7 "httpHeaders" : { }, 8 "httpStatusCode" : 400, 9 "referenceId" : "badContact" 10}