Provides status information on a batch copy job.
Request
Request syntax:
/batch/get-job-states
Request parameters:
Pass the following parameters through the msg parameter:
| Name | Data Type | Description |
|---|---|---|
| id Required | String | Identifies a batch copy job by its system-defined ID. This ID was provided in the response to the Copy Assets endpoint. |
Authentication
Pass a digital signature based off of msg.
Response
The response for a successful request contains the following parameters.
| Name | Data Type | Description | ||||
|---|---|---|---|---|---|---|
| states | Dictionary | Indicates status information for each copy job in the batch. This parameter may contain one or more of the following lists: waiting | assigned | done | error | cancelled Each list contains the asset IDThis unique ID identifies an asset. View this ID by navigating to the Content tab, selecting the desired asset, and then viewing the GUID option from the Details tab. for each asset in that state. Learn more. |
| error | Integer | Indicates whether an error occurred. |
Sample Request/Response
A sample request/response is provided below. The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.
from uplynk_api2_auth import Call
print(Call('/api2/cloudslicer/batch/get-job-states', id='b3a304b482284968be49571adb6db521'))
{
'states' : {
'done' : ['a0c403730ca14575a92f337ef71e0c5f', 'c0d0013d33d54b7c9354a339bfdc7434']
},
'error' : 0
}