Salesforce · JSON Structure

Salesforce Rest Composite Response Structure

The result of a composite request, containing results for each subrequest in order.

Type: object Properties: 1
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

CompositeResponse is a JSON Structure definition published by Salesforce, describing 1 property. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

compositeResponse

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "The result of a composite request, containing results for each subrequest in order.\n",
  "name": "CompositeResponse",
  "properties": {
    "compositeResponse": {
      "type": "array",
      "description": "Array of results corresponding to each subrequest, in the same order as the input compositeRequest array.\n",
      "items": {
        "type": "object",
        "properties": {
          "body": {
            "type": "object",
            "description": "Response body of the subrequest."
          },
          "httpHeaders": {
            "type": "object",
            "description": "Response HTTP headers for the subrequest."
          },
          "httpStatusCode": {
            "type": "integer",
            "description": "HTTP status code of the subrequest."
          },
          "referenceId": {
            "type": "string",
            "description": "The reference ID of the corresponding subrequest."
          }
        }
      }
    }
  },
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}