From e7b15c9b9234ced449f5345c41a58799bebad2f7 Mon Sep 17 00:00:00 2001 From: Abzie Date: Tue, 31 Jan 2017 20:44:43 +0000 Subject: [PATCH] Change format from Sonarr to Radarr, tweak some text, remove obsolete commands. --- API:Command.md | 86 ++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 48 deletions(-) diff --git a/API:Command.md b/API:Command.md index faf235f..2e88db0 100644 --- a/API:Command.md +++ b/API:Command.md @@ -22,7 +22,7 @@ Array of json objects For `api/command/{id}` ````JSON { - "name": "RescanSeries", + "name": "RescanMovie", "startedOn": "0001-01-01T00:00:00Z", "stateChangeTime": "2014-02-05T05:09:09.2366139Z", "sendUpdatesToClient": true, @@ -34,7 +34,7 @@ For `api/command/{id}` ## POST ## ##### 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 ###### @@ -46,81 +46,70 @@ Required: ````JSON { - "name": "RescanSeries", - "startedOn": "0001-01-01T00:00:00Z", - "stateChangeTime": "2014-02-05T05:09:09.2366139Z", + "name": "RescanMovie", + "body": { + "sendUpdatesToClient": true, + "updateScheduledTask": true, + "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, - "state": "pending", - "id": 24 + "updateScheduledTask": true, + "id": 26618 } ```` ## Commands ## -### RefreshSeries ### -Refresh series information from trakt and rescan disk +### RefreshMovie ### +Refresh movie information from TMDb and rescan disk ##### Parameters ###### 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 ### -Refresh rescan disk for a single series +### RescanMovie ### +Rescan disk for movies ##### Parameters ###### Optional: -`seriesId (int)` - if not set all series will be scanned +`movieId (int)` - if not set all movies will be scanned --- -### EpisodeSearch ### -Search for one or more episodes +### MovieSearch ### +Search for one or more movies ##### Parameters ###### Required: `episodeIds (int[])` - one or more episodeIds in an array +__Not 100% sure on this command variable__ --- -### SeasonSearch ### -Search for all episodes of a particular season - -##### 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. +### DownloadedMovieScan ### +Instruct Radarr to scan the DroneFactoryFolder or a folder defined by the path variable. 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. -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 ###### @@ -128,12 +117,12 @@ Optional: `path (string)`, `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 ### -Instruct Sonarr to perform an RSS sync with all enabled indexers +Instruct Radarr to perform an RSS sync with all enabled indexers ##### Parameters ###### @@ -142,17 +131,18 @@ None --- ### RenameFiles ### -Instruct Sonarr to rename the list of files provided. +Instruct Radarr to rename the list of files provided. ##### Parameters ###### +Optional: `files (int[])` (List of File IDs to rename) --- -### RenameSeries ### -Instruct Sonarr to rename all files in the provided series. +### RenameMovies ### +Instruct Radarr to rename all files in the provided movies. ##### Parameters ###### -`seriesIds (int[])` (List of Series IDs to rename) \ No newline at end of file +`movieIds (int[])` (List of Movie IDs to rename) \ No newline at end of file