Fetch Queued Items From a Queue
Description:
This is a method for external applications to fetch list of queued items from an Orchestrator queue.
Usage
XML request:
http://Orchestrator_IP_address/aspera/orchestrator/api/queued_items/queue_id.format?login=admin&password=aspera
The required input parameter is queue_id=queue_id.
XML
example:
http://localhost/aspera/orchestrator/api/queued_items/transcode.xml?login=admin&password=aspera
Example response (XML):
<?xml version="1.0"?>
<Queue>
<Queued_items>
<Queued_item>
<priority>100</priority>
<weight>3859</weight>
<queued_item>/demo/to_transcoder/3_10_to_Yuma.avi</queued_item>
<id>587</id>
<updated_at>Tue Jan 06 21:38:51 UTC 2015</updated_at>
<position>50</position>
<originator_type></originator_type>
<originator_id>64623</originator_id>
<item_description>3_10_to_Yuma</item_description>
<rank>0</rank>
<created_at>Tue Jan 06 19:29:01 UTC 2015</created_at>
</Queued_item>
<Queued_item>
<priority>100</priority>
<weight>12823</weight>
<queued_item>/demo/to_transcoder/39steps_train.avi</queued_item>
<id>586</id>
<updated_at>Tue Jan 06 19:28:54 UTC 2015</updated_at>
<position>100</position>
<originator_type></originator_type>
<originator_id>64621</originator_id>
<item_description>39steps_train</item_description>
<rank>1</rank>
<created_at>Tue Jan 06 19:28:54 UTC 2015</created_at>
</Queued_item>
</Queued_items>
<Queue_metadata>
<comments>ad_hoc creation for QueueStager #4</comments>
<administrators>
<group>1</group>
<user>3</user>
</administrators>
<id>transcode</id>
<paused>true</paused>
<name>transcode</name>
</Queue_metadata>
</Queue>
JSON
request:
http://localhost/aspera/orchestrator/api/queued_items/transcode.json?login=admin&password=aspera
Example response:
(JSON):
{
"queue": {
"name": "transcode",
"comments": "ad_hoc creation for QueueStager #4",
"administrators": {
"groups": [
1
],
"users": [
3
]
},
"paused": true,
"id": "transcode"
},
"queued_items": [
{
"item_description": "3_10_to_Yuma",
"weight": 3859,
"position": 50,
"originator_id": 64623,
"originator_type": null,
"updated_at": "2015-01-06T21:38:51Z",
"rank": 0,
"queued_item": "/demo/to_transcoder/3_10_to_Yuma.avi",
"priority": 100,
"id": 587,
"created_at": "2015-01-06T19:29:01Z"
},
{
"item_description": "39steps_train",
"weight": 12823,
"position": 100,
"originator_id": 64621,
"originator_type": null,
"updated_at": "2015-01-06T19:28:54Z",
"rank": 1,
"queued_item": "/demo/to_transcoder/39steps_train.avi",
"priority": 100,
"id": 586,
"created_at": "2015-01-06T19:28:54Z"
}
]}