mirror of
https://github.com/Radarr/Radarr.git
synced 2024-10-02 06:07:19 +02:00
Added API:Movie doc
Abzie
parent
ba6b8b5767
commit
dfba953069
276
API:Movie.md
Normal file
276
API:Movie.md
Normal file
@ -0,0 +1,276 @@
|
||||
**Endpoint: "/movie"**
|
||||
|
||||
## GET ##
|
||||
|
||||
##### Summary #####
|
||||
Returns all Movies in your collection
|
||||
|
||||
##### Parameters ######
|
||||
|
||||
*None*
|
||||
|
||||
##### Returns JsonArray ######
|
||||
|
||||
```JSON
|
||||
[
|
||||
{
|
||||
"title": "Assassin's Creed",
|
||||
"sortTitle": "assassins creed",
|
||||
"sizeOnDisk": 0,
|
||||
"status": "released",
|
||||
"overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
|
||||
"inCinemas": "2016-12-21T00:00:00Z",
|
||||
"images": [
|
||||
{
|
||||
"coverType": "poster",
|
||||
"url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
|
||||
},
|
||||
{
|
||||
"coverType": "banner",
|
||||
"url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
|
||||
}
|
||||
],
|
||||
"website": "https://www.ubisoft.com/en-US/",
|
||||
"downloaded": false,
|
||||
"year": 2016,
|
||||
"hasFile": false,
|
||||
"youTubeTrailerId": "pgALJgMjXN4",
|
||||
"studio": "20th Century Fox",
|
||||
"path": "/path/to/Assassin's Creed (2016)",
|
||||
"profileId": 6,
|
||||
"monitored": true,
|
||||
"runtime": 115,
|
||||
"lastInfoSync": "2017-01-23T22:05:32.365337Z",
|
||||
"cleanTitle": "assassinscreed",
|
||||
"imdbId": "tt2094766",
|
||||
"tmdbId": 121856,
|
||||
"titleSlug": "assassins-creed-2016",
|
||||
"genres": [
|
||||
"Action",
|
||||
"Adventure",
|
||||
"Fantasy",
|
||||
"Science Fiction"
|
||||
],
|
||||
"tags": [],
|
||||
"added": "2017-01-14T20:18:52.938244Z",
|
||||
"ratings": {
|
||||
"votes": 711,
|
||||
"value": 5.2
|
||||
},
|
||||
"alternativeTitles": [
|
||||
"Assassin's Creed: The IMAX Experience"
|
||||
],
|
||||
"qualityProfileId": 6,
|
||||
"id": 1
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## GET/{id} ##
|
||||
|
||||
##### Summary #####
|
||||
Returns the movie with the matching ID or 404 if no matching movie is found
|
||||
|
||||
##### Parameters ######
|
||||
|
||||
`id (int)`
|
||||
|
||||
##### Returns JsonObject ######
|
||||
|
||||
````JSON
|
||||
{
|
||||
"title": "Assassin's Creed",
|
||||
"sortTitle": "assassins creed",
|
||||
"sizeOnDisk": 0,
|
||||
"status": "released",
|
||||
"overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
|
||||
"inCinemas": "2016-12-21T00:00:00Z",
|
||||
"images": [
|
||||
{
|
||||
"coverType": "poster",
|
||||
"url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
|
||||
},
|
||||
{
|
||||
"coverType": "banner",
|
||||
"url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
|
||||
}
|
||||
],
|
||||
"website": "https://www.ubisoft.com/en-US/",
|
||||
"downloaded": false,
|
||||
"year": 2016,
|
||||
"hasFile": false,
|
||||
"youTubeTrailerId": "pgALJgMjXN4",
|
||||
"studio": "20th Century Fox",
|
||||
"path": "/mnt/nas/movies/Assassin's Creed (2016)",
|
||||
"profileId": 6,
|
||||
"monitored": true,
|
||||
"runtime": 115,
|
||||
"lastInfoSync": "2017-01-23T22:05:32.365337Z",
|
||||
"cleanTitle": "assassinscreed",
|
||||
"imdbId": "tt2094766",
|
||||
"tmdbId": 121856,
|
||||
"titleSlug": "assassins-creed-2016",
|
||||
"genres": [
|
||||
"Action",
|
||||
"Adventure",
|
||||
"Fantasy",
|
||||
"Science Fiction"
|
||||
],
|
||||
"tags": [],
|
||||
"added": "2017-01-14T20:18:52.938244Z",
|
||||
"ratings": {
|
||||
"votes": 711,
|
||||
"value": 5.2
|
||||
},
|
||||
"alternativeTitles": [
|
||||
"Assassin's Creed: The IMAX Experience"
|
||||
],
|
||||
"qualityProfileId": 6,
|
||||
"id": 1
|
||||
}
|
||||
````
|
||||
|
||||
## POST ##
|
||||
|
||||
##### Summary #####
|
||||
Adds a new movie to your collection
|
||||
|
||||
##### Parameters ######
|
||||
|
||||
NOTE: if you do not add the required params, then the movie addition wont function. Some of these without the others can indeed make a "movie". But it wont function properly in Radarr.
|
||||
|
||||
Required:
|
||||
`imdbId (int)`
|
||||
`title (string)`
|
||||
`qualityProfileId (int)`
|
||||
`titleSlug (string)`
|
||||
`images (array)`
|
||||
`tmdbId (int)`
|
||||
`path (string)` - full path to the movie on disk
|
||||
*or*
|
||||
`rootFolderPath (string)` - full path will be created by combining the rootFolderPath with the movie title
|
||||
|
||||
Optional:
|
||||
`monitored (bool)`
|
||||
`addOptions (object)`
|
||||
|
||||
##### Returns JsonObject ######
|
||||
|
||||
````JSON
|
||||
{
|
||||
"title": "Minions (2015)",
|
||||
"sortTitle": "minions 2015",
|
||||
"sizeOnDisk": 0,
|
||||
"status": "tba",
|
||||
"images": [
|
||||
{
|
||||
"coverType": "poster",
|
||||
"url": "/radarr/MediaCover/11/poster.jpg"
|
||||
},
|
||||
{
|
||||
"coverType": "banner",
|
||||
"url": "/radarr/MediaCover/11/banner.jpg"
|
||||
}
|
||||
],
|
||||
"downloaded": false,
|
||||
"year": 0,
|
||||
"hasFile": false,
|
||||
"path": "/mnt/nas/movies/Minions (2015)",
|
||||
"profileId": 6,
|
||||
"monitored": true,
|
||||
"runtime": 0,
|
||||
"cleanTitle": "minions2015",
|
||||
"imdbId": "tt2293640",
|
||||
"tmdbId": 211672,
|
||||
"titleSlug": "minions-2015",
|
||||
"genres": [],
|
||||
"tags": [],
|
||||
"added": "2017-01-24T14:26:55.165661Z",
|
||||
"alternativeTitles": [],
|
||||
"qualityProfileId": 6,
|
||||
"id": 11
|
||||
}
|
||||
````
|
||||
|
||||
## PUT ##
|
||||
|
||||
##### Summary #####
|
||||
Update an existing movie
|
||||
|
||||
##### Parameters ######
|
||||
|
||||
Required:
|
||||
All parameters (you should perform a GET/{id} and submit the full body with the changes
|
||||
|
||||
##### Returns JsonObject ######
|
||||
|
||||
````JSON
|
||||
{
|
||||
"title": "Assassin's Creed",
|
||||
"sortTitle": "assassins creed",
|
||||
"sizeOnDisk": 0,
|
||||
"status": "released",
|
||||
"overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
|
||||
"inCinemas": "2016-12-21T00:00:00Z",
|
||||
"images": [
|
||||
{
|
||||
"coverType": "poster",
|
||||
"url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
|
||||
},
|
||||
{
|
||||
"coverType": "banner",
|
||||
"url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
|
||||
}
|
||||
],
|
||||
"website": "https://www.ubisoft.com/en-US/",
|
||||
"downloaded": false,
|
||||
"year": 2016,
|
||||
"hasFile": false,
|
||||
"youTubeTrailerId": "pgALJgMjXN4",
|
||||
"studio": "20th Century Fox",
|
||||
"path": "/mnt/nas/movies/Assassin's Creed (2016)",
|
||||
"profileId": 6,
|
||||
"monitored": true,
|
||||
"runtime": 115,
|
||||
"lastInfoSync": "2017-01-23T22:05:32.365337Z",
|
||||
"cleanTitle": "assassinscreed",
|
||||
"imdbId": "tt2094766",
|
||||
"tmdbId": 121856,
|
||||
"titleSlug": "assassins-creed-2016",
|
||||
"genres": [
|
||||
"Action",
|
||||
"Adventure",
|
||||
"Fantasy",
|
||||
"Science Fiction"
|
||||
],
|
||||
"tags": [],
|
||||
"added": "2017-01-14T20:18:52.938244Z",
|
||||
"ratings": {
|
||||
"votes": 711,
|
||||
"value": 5.2
|
||||
},
|
||||
"alternativeTitles": [
|
||||
"Assassin's Creed: The IMAX Experience"
|
||||
],
|
||||
"qualityProfileId": 6,
|
||||
"id": 1
|
||||
}
|
||||
````
|
||||
|
||||
## DELETE/{id} ##
|
||||
|
||||
##### Summary #####
|
||||
Delete the movie with the given ID
|
||||
|
||||
##### Parameters ######
|
||||
|
||||
Required:
|
||||
`id (int)`
|
||||
|
||||
Optional:
|
||||
`deleteFiles (bool)` - if true the movie folder and all files will be deleted when the movie is deleted
|
||||
|
||||
##### Returns JsonObject ######
|
||||
````JSON
|
||||
{}
|
||||
````
|
||||
Loading…
Reference in New Issue
Block a user