Reorder a Queued Item

This endpoint reorders a queued item.

Four reorder operations are supported:
  • up - move up by one rank
  • down - move down by one rank
  • first - move to the top of the queue
  • last - move to the bottom of the queue
In the response, the rank field only changes if an operation was successful. A rank of 0 indicates the queued item is on top of the queue.
Note: The default format for the response is XML format. To return a response in JSON format, add &format=json to the request.

Usage: Search for an Item in a Specific Queue

The queued item provided in the URL must be a string match to the queued item in the database.

Request:
http://Orchestrator_IP_address/aspera/orchestrator/api/reorder_queued_item?queue_name=CP_ENT_FFMPEG&format=xml&queued_item=test&login=admin&operation=up
Sample response:
<Queue>
    <Queue_metadata>
        <comments>ad_hoc creation for QueueStager #37</comments>
        <administrators></administrators>
        <name>CP_ENT_FFMPEG</name>
        <paused>false</paused>
    </Queue_metadata>
    <Queued_items>
        <Queued_item>
            <updated_at>Wed Apr 29 22:06:50 UTC 2015</updated_at>
            <originator_type/>
            <id>26</id>
            <created_at>Wed Apr 29 22:06:50 UTC 2015</created_at>
            <queued_item>test</queued_item>
            <position>100</position>
            <rank>0</rank>
            <weight>0</weight>
            <originator_id>1217</originator_id>
            <item_description>test</item_description>
            <priority>100</priority>
        </Queued_item>
    </Queued_items>
</Queue>

Usage: Search by a Queued Item ID

The value of a queued item ID can be obtained from the Get Queued Items From a Queue API method or the Look Up an Item in a Queue API method.

Request
http://Orchestrator_IP_address/aspera/orchestrator/api/reorder_queued_item?format=xml&queued_item_id=29&login=admin&operation=down
Response example:
<Queue>
    <Queue_metadata>
        <comments>ad_hoc creation for QueueStager #21</comments>
        <administrators>
            <group>1</group>
            <group>2</group>
            <group>4</group>
            <group>5</group>
            <group>6</group>
        </administrators>
        <name>Dev_QC_Action</name>
        <paused>false</paused>
    </Queue_metadata>
    <Queued_items>
        <Queued_item>
            <originator_type/>
            <created_at>Fri Dec 04 08:23:49 UTC 2015</created_at>
            <position>110</position>
            <rank>1</rank>
            <updated_at>Fri Dec 04 08:23:49 UTC 2015</updated_at>
            <originator_id/>
            <priority>100</priority>
            <weight>0</weight>
            <queued_item>test_add1</queued_item>
            <item_description/>
            <id>29</id>
        </Queued_item>
    </Queued_items>
</Queue>