Bulk Reorder a Queued Item

Description:

This API method reorders a list of queued items. Four reorder operations are supported: In the API responses, only the rank field changes if an operation was successfully performed. Rank 0 indicates that the queued item is on top of the queue.

Usage

This API call takes only queue IDs as parameters.

XML response:

http://localhost:5000/aspera/orchestrator/api/bulk_reorder_queue?queued_item_ids=18,19,20,21&format=xml&login=admin&password=admin&operation=first

Sample returned XML:

<Queue>
	<queued_items>
		<queued_item>
			<queued_item>test1</queued_item>
			<updated_at>Thu Aug 18 02:30:43 UTC 2016</updated_at>
			<id>18</id>
			<rank>4</rank>
			<originator_type/>
			<item_description/>
			<position>-395</position>
			<created_at>Fri Jul 29 00:23:09 UTC 2016</created_at>
			<priority>100</priority>
			<weight>0</weight>
			<originator_id>68877</originator_id>
		</queued_item>
		<queue_data>
			<comments/>
			<administrators/>
			<name>new queue 2 </name>
			<paused>true</paused>
		</queue_data>
	</queued_items>
	<queued_items>
		<queued_item>
			<queued_item>test2</queued_item>
			<updated_at>Thu Aug 18 02:30:43 UTC 2016</updated_at>
			<id>19</id>
			<rank>3</rank>
			<originator_type/>
			<item_description/>
			<position>-400</position>
			<created_at>Fri Jul 29 00:23:15 UTC 2016</created_at>
			<priority>100</priority>
			<weight>0</weight>
			<originator_id>68878</originator_id>
		</queued_item>
		<queue_data>
			<comments/>
			<administrators/>
			<name>new queue 2 </name>
			<paused>true</paused>
		</queue_data>
	</queued_items>
	<queued_items>
		<queued_item>
			<queued_item>test3</queued_item>
			<updated_at>Thu Aug 18 02:30:43 UTC 2016</updated_at>
			<id>20</id>
			<rank>2</rank>
			<originator_type/>
			<item_description/>
			<position>-405</position>
			<created_at>Fri Jul 29 00:23:21 UTC 2016</created_at>
			<priority>100</priority>
			<weight>0</weight>
			<originator_id>68879</originator_id>
		</queued_item>
		<queue_data>
			<comments/>
			<administrators/>
			<name>new queue 2 </name>
			<paused>true</paused>
		</queue_data>
	</queued_items>
	<queued_items>
		<queued_item>
			<queued_item>test4</queued_item>
			<updated_at>Thu Aug 18 02:30:43 UTC 2016</updated_at>
			<id>21</id>
			<rank>1</rank>
			<originator_type/>
			<item_description/>
			<position>-410</position>
			<created_at>Fri Jul 29 00:23:28 UTC 2016</created_at>
			<priority>100</priority>
			<weight>0</weight>
			<originator_id>68880</originator_id>
		</queued_item>
		<queue_data>
			<comments/>
			<administrators/>
			<name>new queue 2 </name>
			<paused>true</paused>
		</queue_data>
	</queued_items>
</Queue>
JSON response:
http://localhost:5000/aspera/orchestrator/api/bulk_reorder_queue?queued_item_ids=18,19,20,21&format=json&login=admin&password=admin&operation=first
Sample returned JSON:
{
    "queued_items": [
        {
            "queue_data": {
                "administrators": {
                    "groups": [],
                    "users": []
                },
                "comments": "",
                "name": "new queue 2 ",
                "paused": true
            },
            "queued_item": {
                "created_at": "2016-07-29T00:23:09Z",
                "id": 18,
                "item_description": "",
                "originator_id": 68877,
                "originator_type": null,
                "position": -415,
                "priority": 100,
                "queued_item": "test1",
                "rank": 4,
                "updated_at": "2016-08-18T02:31:22Z",
                "weight": 0
            }
        },
        {
            "queue_data": {
                "administrators": {
                    "groups": [],
                    "users": []
                },
                "comments": "",
                "name": "new queue 2 ",
                "paused": true
            },
            "queued_item": {
                "created_at": "2016-07-29T00:23:15Z",
                "id": 19,
                "item_description": "",
                "originator_id": 68878,
                "originator_type": null,
                "position": -420,
                "priority": 100,
                "queued_item": "test2",
                "rank": 3,
                "updated_at": "2016-08-18T02:31:22Z",
                "weight": 0
            }
        },
        {
            "queue_data": {
                "administrators": {
                    "groups": [],
                    "users": []
                },
                "comments": "",
                "name": "new queue 2 ",
                "paused": true
            },
            "queued_item": {
                "created_at": "2016-07-29T00:23:21Z",
                "id": 20,
                "item_description": "",
                "originator_id": 68879,
                "originator_type": null,
                "position": -425,
                "priority": 100,
                "queued_item": "test3",
                "rank": 2,
                "updated_at": "2016-08-18T02:31:22Z",
                "weight": 0
            }
        },
        {
            "queue_data": {
                "administrators": {
                    "groups": [],
                    "users": []
                },
                "comments": "",
                "name": "new queue 2 ",
                "paused": true
            },
            "queued_item": {
                "created_at": "2016-07-29T00:23:28Z",
                "id": 21,
                "item_description": "",
                "originator_id": 68880,
                "originator_type": null,
                "position": -430,
                "priority": 100,
                "queued_item": "test4",
                "rank": 1,
                "updated_at": "2016-08-18T02:31:22Z",
                "weight": 0
            }
        }
    ]
}