Salesforce · Schema

CompositeResponse

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

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
compositeResponse array Array of results corresponding to each subrequest, in the same order as the input compositeRequest array.
View JSON Schema on GitHub

JSON Schema

salesforce-rest-composite-response-schema.json Raw ↑
{
  "type": "object",
  "description": "The result of a composite request, containing results for each subrequest in order.\n",
  "properties": {
    "compositeResponse": {
      "type": "array",
      "description": "Array of results corresponding to each subrequest, in the same order as the input compositeRequest array.\n",
      "example": [],
      "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-schema.org/draft/2020-12/schema",
  "title": "CompositeResponse"
}