4
Queue
Qstick edited this page 4 years ago
Endpoint: "/queue"
GET
Summary
Gets item in activity queue
Parameters
Optional:
page (int) - 1-indexed Default: 1
pageSize (int) - Default: 10
sortKey (string) - estimatedCompletionTime, timeleft, artist.sortName, album.title, progress, quality - Default: timeleft
sortDir (string) - asc or desc - Default: asc
includeArtist - true or false - Default: false
includeAlbum - true or false - Default: false
Returns JsonArray
{
"page": 1,
"pageSize": 10,
"sortKey": "timeleft",
"sortDirection": "ascending",
"totalRecords": 3,
"records": [
{
"artistId": 518,
"albumId": 6455,
"quality": {
"quality": {
"id": 6,
"name": "FLAC"
},
"revision": {
"version": 1,
"real": 0
}
},
"size": 553272291.0,
"title": "Cream-Wheels Of Fire-2CD-FLAC-1986-FiXIE",
"sizeleft": 407361793.0,
"status": "Paused",
"trackedDownloadStatus": "Ok",
"statusMessages": [],
"downloadId": "52864e6ed0asdf4353cfa9416296f",
"protocol": "usenet",
"downloadClient": "NzbGet",
"id": 435807309
},
{
"artistId": 517,
"albumId": 6472,
"quality": {
"quality": {
"id": 6,
"name": "FLAC"
},
"revision": {
"version": 1,
"real": 0
}
},
"size": 456766154.0,
"title": "Bruce Springsteen-High Hopes-CD-FLAC-2014-PERFECT",
"sizeleft": 456766154.0,
"status": "Paused",
"trackedDownloadStatus": "Ok",
"statusMessages": [],
"downloadId": "7e059287ea535634324523d412b5a04",
"protocol": "usenet",
"downloadClient": "NzbGet",
"id": 1587434714
},
{
"artistId": 504,
"albumId": 6412,
"quality": {
"quality": {
"id": 6,
"name": "FLAC"
},
"revision": {
"version": 1,
"real": 0
}
},
"size": 570506235.0,
"title": "The Weeknd-Starboy-Deluxe Edition-CD-FLAC-2016-PERFECT",
"sizeleft": 570506235.0,
"status": "Paused",
"trackedDownloadStatus": "Ok",
"statusMessages": [],
"downloadId": "ac48c2cf7b34576745bbff5cc25",
"protocol": "usenet",
"downloadClient": "NzbGet",
"indexer": "NZBgeek",
"id": 466294042
}
]
}
DELETE
Summary
Removes an Item from Queue and Download Client
Parameters
Required:
id (int) - Unique ID of the queue item
Optional:
blacklist (bool) - true or false - Set to 'true' to blacklist after delete
skipredownload (bool) - true or false - Set to 'true' to skip automatic re-download after delete