Mirrors/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr.git synced 2024-11-20 18:02:44 +01:00
Code Issues Releases Wiki Activity

Change format from Sonarr to Radarr, tweak some text, remove obsolete commands.

Abzie 2017-01-31 20:44:43 +00:00
parent 7cfae974ce
commit e7b15c9b92
1 changed files with 38 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
API:Command.md

@ -22,7 +22,7 @@ Array of json objects
For `api/command/{id}` For `api/command/{id}`
````JSON ````JSON
{ {
"name": "RescanSeries", "name": "RescanMovie",
"startedOn": "0001-01-01T00:00:00Z", "startedOn": "0001-01-01T00:00:00Z",
"stateChangeTime": "2014-02-05T05:09:09.2366139Z", "stateChangeTime": "2014-02-05T05:09:09.2366139Z",
"sendUpdatesToClient": true, "sendUpdatesToClient": true,
@ -34,7 +34,7 @@ For `api/command/{id}`
## POST ## ## POST ##
##### Summary ##### ##### Summary #####
Publish a new command for Sonarr to run. These commands are executed asynchronously; use GET to retrieve the current status. Publish a new command for Radarr to run. These commands are executed asynchronously; use GET to retrieve the current status.
##### Parameters ###### ##### Parameters ######
@ -46,81 +46,70 @@ Required:
````JSON ````JSON
{ {
"name": "RescanSeries", "name": "RescanMovie",
"startedOn": "0001-01-01T00:00:00Z", "body": {
"stateChangeTime": "2014-02-05T05:09:09.2366139Z",
"sendUpdatesToClient": true, "sendUpdatesToClient": true,
"state": "pending", "updateScheduledTask": true,
"id": 24 "completionMessage": "Completed",
"name": "RescanMovie",
"trigger": "manual"
},
"priority": "normal",
"status": "queued",
"queued": "2017-01-31T20:36:32.296558Z",
"trigger": "manual",
"state": "queued",
"manual": true,
"startedOn": "2017-01-31T20:36:32.296558Z",
"sendUpdatesToClient": true,
"updateScheduledTask": true,
"id": 26618
} }
```` ````
## Commands ## ## Commands ##
### RefreshSeries ### ### RefreshMovie ###
Refresh series information from trakt and rescan disk Refresh movie information from TMDb and rescan disk
##### Parameters ###### ##### Parameters ######
Optional: Optional:
`seriesId (int)` - if not set all series will be refreshed and scanned `movieId (int)` - if not set all movies will be refreshed and scanned
--- ---
### RescanSeries ### ### RescanMovie ###
Refresh rescan disk for a single series Rescan disk for movies
##### Parameters ###### ##### Parameters ######
Optional: Optional:
`seriesId (int)` - if not set all series will be scanned `movieId (int)` - if not set all movies will be scanned
--- ---
### EpisodeSearch ### ### MovieSearch ###
Search for one or more episodes Search for one or more movies
##### Parameters ###### ##### Parameters ######
Required: Required:
`episodeIds (int[])` - one or more episodeIds in an array `episodeIds (int[])` - one or more episodeIds in an array
__Not 100% sure on this command variable__
--- ---
### SeasonSearch ### ### DownloadedMovieScan ###
Search for all episodes of a particular season Instruct Radarr to scan the DroneFactoryFolder or a folder defined by the path variable.
##### Parameters ######
Required:
`seriesId (int)`
`seasonNumber (int)`
---
### SeriesSearch ###
Search for all episodes in a series
##### Parameters ######
Required:
`seriesId (int)`
---
### DownloadedEpisodesScan ###
Instruct Sonarr to scan the DroneFactoryFolder or a folder defined by the path variable.
Each file and folder in the DroneFactoryFolder is interpreted as separate download. Each file and folder in the DroneFactoryFolder is interpreted as separate download.
But a folder specified by the path variable is assumed to be a single download (job) and the folder name should be the release name. But a folder specified by the path variable is assumed to be a single download (job) and the folder name should be the release name.
The downloadClientId can be used to support this API endpoint in conjunction with Completed Download Handling, so Sonarr knows that a particular download has already been imported. The downloadClientId can be used to support this API endpoint in conjunction with Completed Download Handling, so Radarr knows that a particular download has already been imported.
##### Parameters ###### ##### Parameters ######
@ -128,12 +117,12 @@ Optional:
`path (string)`, `path (string)`,
`downloadClientId (string)` (nzoid for sabnzbd, special 'drone' attribute value for nzbget, uppercase infohash for torrents), `downloadClientId (string)` (nzoid for sabnzbd, special 'drone' attribute value for nzbget, uppercase infohash for torrents),
`importMode (string)` = `Move` or `Copy` (Copy = Copy Or Hardlink depending on Sonarr configuration) Can be used to override the default Copy for torrents with external preprocessing/transcoding/unrar. `importMode (string)` = `Move` or `Copy` (Copy = Copy Or Hardlink depending on Radarr configuration) Can be used to override the default Copy for torrents with external preprocessing/transcoding/unrar.
--- ---
### RssSync ### ### RssSync ###
Instruct Sonarr to perform an RSS sync with all enabled indexers Instruct Radarr to perform an RSS sync with all enabled indexers
##### Parameters ###### ##### Parameters ######
@ -142,17 +131,18 @@ None
--- ---
### RenameFiles ### ### RenameFiles ###
Instruct Sonarr to rename the list of files provided. Instruct Radarr to rename the list of files provided.
##### Parameters ###### ##### Parameters ######
Optional:
`files (int[])` (List of File IDs to rename) `files (int[])` (List of File IDs to rename)
--- ---
### RenameSeries ### ### RenameMovies ###
Instruct Sonarr to rename all files in the provided series. Instruct Radarr to rename all files in the provided movies.
##### Parameters ###### ##### Parameters ######
`seriesIds (int[])` (List of Series IDs to rename) `movieIds (int[])` (List of Movie IDs to rename)