Tooling API

Introducing Tooling API
When to Use Tooling API
REST Overview
REST Resources
REST Resource Examples
REST Headers
REST Header Examples
Improve Performance with the Composite Resource
Composite Request Body
Composite Response Body
SOAP Calls
Tooling API Objects and Namespaces
Tooling API Objects
SOAP Headers for Tooling API
REST Headers for Tooling API
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Composite Response Body

Describes the result of a /tooling/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. If the subrequest returns an error, the body includes the error code and message.
httpHeaders Map<String, String> Response headers and their values for this subrequest. The /tooling/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. Use this property to associate subrequests with their results.
JSON example
1{
2   "body" : {       
3      "id" : "001R00000033I6AIAU",
4      "success" : true,
5      "errors" : [ ]
6   },
7   "httpHeaders" : { 
8      "Location" : "/services/data/v40.0/tooling/sobjects/apexclassmember/001R00000033I6AIAU"
9   },
10   "httpStatusCode" : 201,
11   "referenceId" : "apexclassmember_reference_id"
12}