Basic status of all jobs in your queue.
Request
<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required -->
<userkey><<key>></userkey> <!-- required -->
<action>GetStatus</action> <!-- required -->
<mediaid>[MediaID]</mediaid> <!-- required -->
<include_task_status>[yes|no]</include_task_status>
<include_qc_task_status>[yes|no]</include_qc_task_status>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "GetStatus", // required
"mediaid": "[MediaID]", // required
"include_task_status": "[yes|no]",
"include_qc_task_status": "[yes|no]"
}
}
Parameter | Description | Allowed Values | Default Value |
---|---|---|---|
mediaid | Media ID | Positive integer number | none |
include_task_status | Include Task Processing log | yes, no | no |
include_qc_task_status | Include child QC media processing log | yes, no | no |
Response
<?xml version="1.0"?>
<response>
<id>[MediaID]</id>
<userid><<id>></userid>
<sourcefile>[SourceFile]</sourcefile>
<status>[MediaStatus]</status>
<notifyurl>[NotifyURL]</notifyurl>
<created>[Date]</created>
<started>[Date]</started>
<finished>[Date]</finished>
<prevstatus>[MediaStatus]</prevstatus>
<downloaded>[Date]</downloaded>
<uploaded>[Date]</uploaded>
<time_left>[TotalTimeLeft]</time_left>
<progress>[TotalProgress]</progress>
<time_left_current>[StatusTimeLeft]</time_left_current>
<progress_current>[StatusProgress]</progress_current>
<format>
<id>[ID]</id>
<status>[Status]</status>
<created>[Date]</created>
<started>[Date]</started>
<finished>[Date]</finished>
<!-- other format fields -->
<s3_destination>[TempS3Link]</s3_destination> <!-- optional -->
<cf_destination>[TempCFLink]</cf_destination> <!-- optional -->
<destination>[URL]</destination>
<destination_status>[Saved|Error (ErrorDescription)]</destination_status>
<destination>[URL_2]</destination>
<destination_status>[Saved|Error (ErrorDescription)]</destination_status>
<!-- ... -->
<destination>[URL_N]</destination>
<destination_status>[Saved|Error (ErrorDescription)]</destination_status>
<task_status>
<state>
<time>[StateDateTime]</time>
<message>[Message]</message>
</state>
<state>
<time>[StateDateTime]</time>
<message>[Message]</message>
</state>
<!-- multiple state messages -->
<state>
<time>[StateDateTime]</time>
<message>[Message]</message>
</state>
</task_status>
</format>
<format>
<!-- ... -->
</format>
</response>
{
"response": {
"id": "[MediaID]",
"userid": "<<id>>",
"sourcefile": "[SourceFile]",
"status": "[MediaStatus]",
"notifyurl": "[NotifyURL]",
"created": "[Date]",
"started": "[Date]",
"finished": "[Date]",
"prevstatus": "[MediaStatus]",
"downloaded": "[Date]",
"uploaded": "[Date]",
"time_left": "[TotalTimeLeft]",
"progress": "[TotalProgress]",
"time_left_current": "[StatusTimeLeft]",
"progress_current": "[StatusProgress]",
"format": [
{
"id": "[ID]",
"status": "[Status]",
"created": "[Date]",
"started": "[Date]",
"finished": "[Date]",
"s3_destination": "[TempS3Link]",
"cf_destination": "[TempCFLink]",
"destination": [
"[URL]",
"[URL_2]",
"[URL_N]"
],
"destination_status": [
"[Saved|Error (ErrorDescription)]",
"[Saved|Error (ErrorDescription)]",
"[Saved|Error (ErrorDescription)]"
],
"task_status": {
"state": [
{
"time": "[StateDateTime]",
"message": "[Message]"
},
{
"time": "[StateDateTime]",
"message": "[Message]"
},
// multiple state messages
{
"time": "[StateDateTime]",
"message": "[Message]"
}
]
}
},
{
// format params
}
]
}
}
Parameter | Description |
---|---|
Date | Using this format: YYYY-MM-DD HH:MM:SS |
FormatFields | A set of parameters corresponding to the section of an API request. |
TotalTimeLeft | Estimated time until the media processing will complete. |
StatusTimeLeft | Estimated time remaining for the media's current status |
TotalProgress | Estimated progress for the entire job, as a percentage. |
StatusProgress | Estimated progress for the job's current status, as a percentage. |
TempS3Link | S3 URL of the encoded file only when the was empty and the output is delivered to S3. |
TempCFLink | CDN URL of the output when the parameter is not included and output is delivered to RackSpace cloud files. |
MediaStatus | Uses the following values: 'New', 'Downloading', 'Ready to process', 'Waiting for encoder', 'Processing', 'Saving', 'Finished', 'Error'. |
Status | Uses the following values: 'New', 'Waiting for encoder', 'Processing', 'Saving', 'Finished', 'Error'. |