Webex · Schema

BatchResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Job name.
id	string	Unique identifier of the job.
trackingId	string	Unique identifier to track the flow of HTTP requests.
sourceUserId	string	Unique identifier to identify which user has run the job.
sourceCustomerId	string	Unique identifier to identify the customer who has run the job.
targetCustomerId	string	Unique identifier to identify the customer for which the job was run.
instanceId	number	Unique identifier to identify the instance of the job.
jobExecutionStatus	array	Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job.
latestExecutionStatus	string	Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation.
latestExecutionExitCode	string	Most recent exit code of the job at the time of invocation. * `UNKNOWN` - Job is in progress. * `COMPLETED` - Job has completed successfully. * `FAILED` - Job has failed. * `STOPPED` - Job has been st
counts	object	Job statistics.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BatchResponse",
  "title": "BatchResponse",
  "type": "object",
  "required": [
    "name",
    "id",
    "trackingId",
    "sourceUserId",
    "sourceCustomerId",
    "targetCustomerId",
    "instanceId",
    "latestExecutionStatus",
    "counts"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Job name."
    },
    "id": {
      "type": "string",
      "description": "Unique identifier of the job."
    },
    "trackingId": {
      "type": "string",
      "description": "Unique identifier to track the flow of HTTP requests."
    },
    "sourceUserId": {
      "type": "string",
      "description": "Unique identifier to identify which user has run the job."
    },
    "sourceCustomerId": {
      "type": "string",
      "description": "Unique identifier to identify the customer who has run the job."
    },
    "targetCustomerId": {
      "type": "string",
      "description": "Unique identifier to identify the customer for which the job was run."
    },
    "instanceId": {
      "type": "number",
      "description": "Unique identifier to identify the instance of the job."
    },
    "jobExecutionStatus": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobExecutionStatus"
      },
      "description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
    },
    "latestExecutionStatus": {
      "type": "string",
      "description": "Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation."
    },
    "latestExecutionExitCode": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "COMPLETED",
        "FAILED",
        "STOPPED",
        "COMPLETED_WITH_ERRORS"
      ],
      "description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
    },
    "counts": {
      "$ref": "#/components/schemas/Counts",
      "description": "Job statistics."
    }
  }
}