Webex · Schema

RebuildPhonesJob

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Name of the job which in this case, is `rebuildphones`.
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 has run the job.
sourceCustomerId	string	Unique identifier of the customer who has run the job.
targetCustomerId	string	Unique identifier of 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	object	Indicates the most recent status 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
target	string	Indicates the target entity, i.e. LOCATION.
locationId	string	Unique identifier of a location.
percentageComplete	integer	Indicates the progress of the job.
deviceCount	number	Count of number of devices rebuilt.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RebuildPhonesJob",
  "title": "RebuildPhonesJob",
  "type": "object",
  "required": [
    "name",
    "id",
    "trackingId",
    "sourceUserId",
    "sourceCustomerId",
    "targetCustomerId",
    "instanceId",
    "latestExecutionStatus",
    "target",
    "percentageComplete"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "rebuildphones",
      "description": "Name of the job which in this case, is `rebuildphones`."
    },
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
      "description": "Unique identifier of the job."
    },
    "trackingId": {
      "type": "string",
      "example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
      "description": "Unique identifier to track the flow of HTTP requests."
    },
    "sourceUserId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
      "description": "Unique identifier of the user who has run the job."
    },
    "sourceCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
      "description": "Unique identifier of the customer who has run the job."
    },
    "targetCustomerId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
      "description": "Unique identifier of the customer for which the job was run."
    },
    "instanceId": {
      "type": "number",
      "example": 428989,
      "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": {
      "$ref": "#/components/schemas/LatestExecutionStatus",
      "description": "Indicates the most recent status 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"
    },
    "target": {
      "type": "string",
      "example": "LOCATION",
      "description": "Indicates the target entity, i.e. LOCATION."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
      "description": "Unique identifier of a location."
    },
    "percentageComplete": {
      "type": "integer",
      "example": 10,
      "description": "Indicates the progress of the job."
    },
    "deviceCount": {
      "type": "number",
      "example": 10,
      "description": "Count of number of devices rebuilt."
    }
  }
}