Webex · Schema

jobListResponseObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	Unique identifier of the job.
jobType	string	Job type.
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	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
operationType	string	The operation type that was carried out.
sourceLocationId	string	Unique location identifier for which the job was run.
targetLocationId	string	Unique location identifier for which the numbers have been moved.
counts	object	Job statistics.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/jobListResponseObject",
  "title": "jobListResponseObject",
  "type": "object",
  "required": [
    "id",
    "jobType",
    "trackingId",
    "sourceUserId",
    "sourceCustomerId",
    "targetCustomerId",
    "instanceId",
    "latestExecutionStatus",
    "operationType",
    "sourceLocationId",
    "targetLocationId",
    "counts"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
      "description": "Unique identifier of the job."
    },
    "jobType": {
      "type": "string",
      "example": "managenumbers",
      "description": "Job type."
    },
    "trackingId": {
      "type": "string",
      "example": "ATLAS_06a92f81-244d-4fd2-b8db-121bc1eeb6c8_11",
      "description": "Unique identifier to track the flow of HTTP requests."
    },
    "sourceUserId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU",
      "description": "Unique identifier to identify which user has run the job."
    },
    "sourceCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
      "description": "Unique identifier to identify the customer who has run the job."
    },
    "targetCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
      "description": "Unique identifier to identify the customer for which the job was run."
    },
    "instanceId": {
      "type": "number",
      "example": 238972,
      "description": "Unique identifier to identify the instance of the job."
    },
    "jobExecutionStatus": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobExecutionStatusObject"
      },
      "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",
      "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"
    },
    "operationType": {
      "type": "string",
      "example": "MOVE",
      "description": "The operation type that was carried out."
    },
    "sourceLocationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E2MmRlOWRkLWRmODEtNDg3My04MGY5LTY2MmYyZmM3ZTI2NQ",
      "description": "Unique location identifier for which the job was run."
    },
    "targetLocationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw",
      "description": "Unique location identifier for which the numbers have been moved."
    },
    "counts": {
      "$ref": "#/components/schemas/CountObject",
      "description": "Job statistics."
    }
  }
}