Get Move Users Job Status
Returns the status and other details of the job.
This API requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve job details for this jobId.
Query Parameters
Retrieve job details for this organization.
Response Properties
Job name.
Unique identifier of the job.
Unique identifier to track the flow of HTTP requests.
Unique identifier to identify which user has run the job.
Unique identifier to identify the customer who has run the job.
Unique identifier to identify the customer for which the job was run.
Unique identifier to identify the instance of the job.
Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job.
Unique identifier that identifies each instance of the job.
The date and time with seconds, the job has started in UTC format.
The date and time with seconds, the job has ended in UTC format.
The date and time with seconds, the job has last updated in UTC format post one of the step execution completion.
Displays status for overall steps that are part of the job.
Exit Code for a job.
The date and time with seconds, the job has created in UTC format.
Time lapsed in seconds since the job execution started.
Status of each step within a job.
Unique identifier that identifies each step in a job.
The date and time with seconds, the step execution has started in UTC format.
The date and time with seconds, the step execution has ended in UTC format.
The date and time with seconds, the step has last updated in UTC format.
Displays status for a step.
Exit Code for a step.
Step name.
Time lapsed in seconds since the job execution started.
The most recent status (STARTING,STARTED,COMPLETED,FAILED) of the job at the time of invocation.
Most recent exit code of the job at the time of invocation.
Job is in progress.
Job has completed successfully.
Job has failed.
Job has been stopped.
Job has completed with errors.
Job statistics.
Total number of user moves requested.
Total number of user moves completed successfully.
Total number of user moves that were completed with failures.
Reference ID for the file that holds the errors and impacts.
Date and time with seconds, the file expires in UTC format.
'text/csv', Format of the file generated.
URL to the CSV file containing errors and impacts.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Retrieve job details for this organization.
{
"name": "moveusers",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE",
"trackingId": "ROUTER_6475F43E-A25A-01BB-76CC-AC108AF376CC",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YzJhMDUxMC0wOTUwLTQ1MmYtODFmZi05YTVkMjM2OTJkZTY",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
"instanceId": 328660,
"jobExecutionStatus": [
{
"id": 332387,
"startTime": "2023-05-30T13:04:00.469Z",
"endTime": "2023-05-30T13:04:03.252Z",
"lastUpdated": "2023-05-30T13:04:03.574Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"createdTime": "2023-05-30T13:04:00.457Z",
"stepExecutionStatuses": [
{
"id": 1549115,
"startTime": "2023-05-30T13:04:00.493Z",
"endTime": "2023-05-30T13:04:03.245Z",
"lastUpdated": "2023-05-30T13:04:03.246Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "moveusersvalidateAndMove",
"timeElapsed": "PT2.752S"
}
],
"timeElapsed": "PT2.752S"
}
],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"counts": {
"totalMoves": 1,
"moved": 1,
"failed": 0
},
"csvFile": "02124eef-7be6-489c-805b-363cc6401893/cbf865e9-d069-4004-bb57-2a39f5bfb5fe_d1fde6bf944c40ed8ffbab14e6ca6a12",
"csvFileExpiryTime": "2023-07-12T12:20:33.503Z",
"fileFormat": "text/csv",
"csvFileDownloadUrl": "https://files-int-us-east-1.webexcontent.com/5ab33047-d7ad-42dd-83c5-2e73da63b2ad/8c54b800-10ed-11ee-97c3-a38ed64ceaf4?x-amz-meta-tracking-id=NA_33b1a151-4c47-46a5-8fc5-09f3111c4313&x-amz-meta-user-id=ef2e385f-acad-4e90-8c10-c6532aa0c28d&Expires=1687440028&Signature=ckIcTq-7mUfcdsvSbAR5cUGC76FfyJ6D06~bKXuCrfHkku-eqPsMImRIBCqvWoBRQ1nwGdZk043AFXrwKMxDR9y~GJkzPVAjZwEU3Rr1pK-2aVEDMzP8AVlMYQmJPrmVFlnX8AxDh9YnCeoGUhwUbT~wjyj~NJP3PGfc-hwyXWnFTmdvL3Ehn66z9BQxKksZMOWCyghd~9otoBVC-WyA1Nx2LDOT1qmlLeqN2xwWpdu5Atll0tPUQaOQbCP3-bnOcmL0tR~2gUzfBMUhsW7UO1IPD451va8qcw687~Mglu5VPdpWlIjVXZu6Qk1uCIWSQ0czRDOiFH6RKWtQCD95qw__&Key-Pair-Id=APKAJADAKLCI2FW2U32Q"
}