Composite Response Body

Describes the result of a /composite request.

Composite Results

compositeResponse

JSON Example

{
   "compositeResponse" : [{
      Composite Subrequest Result
      },{
      Composite Subrequest Result
      },{
      Composite Subrequest Result
   }]
}

Composite Subrequest Result

body

  • Type: The type depends on the response type of the subrequest.
  • Description: The response body of this subrequest. If the subrequest returns an error, the body includes the error code and message.

httpHeaders

  • Type: Map<String, String>
  • Description: 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

  • Type: Integer
  • Description: 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

  • Type: String
  • Description: The reference ID specified in the subrequest. Use this property to associate subrequests with their results.

JSON Example

{
   "body" : {
      "id" : "001R00000033I6AIAU",
      "success" : true,
      "errors" : [ ]
   },
   "httpHeaders" : {
      "Location" : "/services/data/v40.0/tooling/sobjects/apexclassmember/001R00000033I6AIAU"
   },
   "httpStatusCode" : 201,
   "referenceId" : "apexclassmember_reference_id"
}