Salesforce · Schema

CompositeResponse

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
body object
httpHeaders object
httpStatusCode integer
referenceId string
View JSON Schema on GitHub

JSON Schema

salesforce-composite-response-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "body": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "abc123"
        },
        "success": {
          "type": "boolean",
          "example": true
        },
        "errors": {
          "type": "array",
          "description": "",
          "example": [],
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "success",
        "errors"
      ]
    },
    "httpHeaders": {
      "type": "object",
      "properties": {
        "Location": {
          "type": "string",
          "example": "example_value"
        }
      },
      "required": [
        "Location"
      ]
    },
    "httpStatusCode": {
      "type": "integer",
      "example": 10
    },
    "referenceId": {
      "type": "string",
      "example": "500123"
    }
  },
  "required": [
    "body",
    "httpHeaders",
    "httpStatusCode",
    "referenceId"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CompositeResponse"
}