Webex · Schema

StartJobResponseObject

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 of the user who ran the job.
sourceCustomerId	string	Unique identifier of the customer who ran the job.
targetCustomerId	string	Unique identifier of the customer for whom the job was run.
instanceId	number	Unique identifier of the job instance.
jobExecutionStatus	array	Most recent step's execution status, including statuses of all steps in the job execution.
latestExecutionStatus	string	Most recent status of the job at the time of invocation. * `STARTING` - Job has started. * `STARTED` - Job is in progress. * `COMPLETED` - Job has completed. * `FAILED` - Job has failed. * `UNKNOWN` -
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	Statistics of the job.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StartJobResponseObject",
  "title": "StartJobResponseObject",
  "type": "object",
  "required": [
    "name",
    "id",
    "trackingId",
    "sourceUserId",
    "sourceCustomerId",
    "targetCustomerId",
    "instanceId",
    "latestExecutionStatus",
    "counts"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "moveusers",
      "description": "Job name."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZjBlN2Q2Ni05MDRlLTRkZGItYjJlNS05ZGM0ODk0ZDY5OTk",
      "description": "Unique identifier of the job."
    },
    "trackingId": {
      "type": "string",
      "example": "ROUTER_ebb52b5b-d060-4164-9757-48b383423d73",
      "description": "Unique identifier to track the flow of HTTP requests."
    },
    "sourceUserId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY",
      "description": "Unique identifier of the user who ran the job."
    },
    "sourceCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
      "description": "Unique identifier of the customer who ran the job."
    },
    "targetCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
      "description": "Unique identifier of the customer for whom the job was run."
    },
    "instanceId": {
      "type": "number",
      "example": 10,
      "description": "Unique identifier of the job instance."
    },
    "jobExecutionStatus": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StartJobExecutionStatusObject"
      },
      "description": "Most recent step's execution status, including statuses of all steps in the job execution."
    },
    "latestExecutionStatus": {
      "type": "string",
      "enum": [
        "STARTING",
        "STARTED",
        "COMPLETED",
        "FAILED",
        "UNKNOWN",
        "ABANDONED"
      ],
      "description": "Most recent status of the job at the time of invocation.\n * `STARTING` - Job has started.\n * `STARTED` - Job is in progress.\n * `COMPLETED` - Job has completed.\n * `FAILED` - Job has failed.\n * `UNKNOWN` - Job status is unknown.\n * `ABANDONED` - Job has been abandoned (manually stopped).\n"
    },
    "latestExecutionExitCode": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "COMPLETED",
        "FAILED",
        "STOPPED",
        "COMPLETED_WITH_ERRORS",
        "COMPLETED_WITH_PENDING_ORDERS"
      ],
      "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 * `COMPLETED_WITH_PENDING_ORDERS` - Job has completed with pending number orders.\n"
    },
    "counts": {
      "$ref": "#/components/schemas/CountObject",
      "description": "Statistics of the job."
    }
  }
}