LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 04:20:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fb62b90f036a0d6ac5a1e22eb49caf2bb804f9c7
plex-docs/docs/plex-media-server/get-on-deck.api.mdx
Luke Hagar 9e0c39c66b dev changes
2023-04-20 07:50:46 -05:00

38 lines
34 KiB
Plaintext
Raw Blame History

---
id: get-on-deck
sidebar_label: Get On Deck
hide_title: true
hide_table_of_contents: true
api: {"tags":["Library"],"description":"This endpoint will return the on deck content.\n","operationId":"getOnDeck","responses":{"200":{"description":"The on Deck content","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number","example":16},"allowSync":{"type":"boolean"},"identifier":{"type":"string","example":"com.plexapp.plugins.library"},"mediaTagPrefix":{"type":"string","example":"/system/bundle/media/flags/"},"mediaTagVersion":{"type":"number","example":1680021154},"mixedParents":{"type":"boolean"},"Metadata":{"type":"array","items":{"type":"object","properties":{"allowSync":{"type":"boolean"},"librarySectionID":{"type":"number","example":2},"librarySectionTitle":{"type":"string","example":"TV Shows"},"librarySectionUUID":{"type":"string","example":"4bb2521c-8ba9-459b-aaee-8ab8bc35eabd"},"ratingKey":{"type":"string","example":49564},"key":{"type":"string","example":"/library/metadata/49564"},"parentRatingKey":{"type":"string","example":49557},"grandparentRatingKey":{"type":"string","example":49556},"guid":{"type":"string","example":"plex://episode/5ea7d7402e7ab10042e74d4f"},"parentGuid":{"type":"string","example":"plex://season/602e754d67f4c8002ce54b3d"},"grandparentGuid":{"type":"string","example":"plex://show/5d9c090e705e7a001e6e94d8"},"type":{"type":"string","example":"episode"},"title":{"type":"string","example":"Circus"},"grandparentKey":{"type":"string","example":"/library/metadata/49556"},"parentKey":{"type":"string","example":"/library/metadata/49557"},"librarySectionKey":{"type":"string","example":"/library/sections/2"},"grandparentTitle":{"type":"string","example":"Bluey (2018)"},"parentTitle":{"type":"string","example":"Season 2"},"contentRating":{"type":"string","example":"TV-Y"},"summary":{"type":"string","example":"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy."},"index":{"type":"number","example":33},"parentIndex":{"type":"number","example":2},"lastViewedAt":{"type":"number","example":1681908352},"year":{"type":"number","example":2018},"thumb":{"type":"string","example":"/library/metadata/49564/thumb/1654258204"},"art":{"type":"string","example":"/library/metadata/49556/art/1680939546"},"parentThumb":{"type":"string","example":"/library/metadata/49557/thumb/1654258204"},"grandparentThumb":{"type":"string","example":"/library/metadata/49556/thumb/1680939546"},"grandparentArt":{"type":"string","example":"/library/metadata/49556/art/1680939546"},"grandparentTheme":{"type":"string","example":"/library/metadata/49556/theme/1680939546"},"duration":{"type":"number","example":420080},"originallyAvailableAt":{"type":"string","format":"date","example":"2020-10-31T00:00:00.000Z"},"addedAt":{"type":"number","example":1654258196},"updatedAt":{"type":"number","example":1654258204},"Media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":80994},"duration":{"type":"number","example":420080},"bitrate":{"type":"number","example":1046},"width":{"type":"number","example":1920},"height":{"type":"number","example":1080},"aspectRatio":{"type":"number","example":1.78},"audioChannels":{"type":"number","example":2},"audioCodec":{"type":"string","example":"aac"},"videoCodec":{"type":"string","example":"hevc"},"videoResolution":{"type":"string","example":1080},"container":{"type":"string","example":"mkv"},"videoFrameRate":{"type":"string","example":"PAL"},"audioProfile":{"type":"string","example":"lc"},"videoProfile":{"type":"string","example":"main"},"Part":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":80994},"key":{"type":"string","example":"/library/parts/80994/1655007810/file.mkv"},"duration":{"type":"number","example":420080},"file":{"type":"string","example":"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv"},"size":{"type":"number","example":55148931},"audioProfile":{"type":"string","example":"lc"},"container":{"type":"string","example":"mkv"},"videoProfile":{"type":"string","example":"main"},"Stream":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":211234},"streamType":{"type":"number","example":1},"default":{"type":"boolean"},"codec":{"type":"string","example":"hevc"},"index":{"type":"number","example":0},"bitrate":{"type":"number","example":918},"language":{"type":"string","example":"English"},"languageTag":{"type":"string","example":"en"},"languageCode":{"type":"string","example":"eng"},"bitDepth":{"type":"number","example":8},"chromaLocation":{"type":"string","example":"left"},"chromaSubsampling":{"type":"string","example":14520},"codedHeight":{"type":"number","example":1080},"codedWidth":{"type":"number","example":1920},"colorRange":{"type":"string","example":"tv"},"frameRate":{"type":"number","example":25},"height":{"type":"number","example":1080},"level":{"type":"number","example":120},"profile":{"type":"string","example":"main"},"refFrames":{"type":"number","example":1},"width":{"type":"number","example":1920},"displayTitle":{"type":"string","example":"1080p (HEVC Main)"},"extendedDisplayTitle":{"type":"string","example":"1080p (HEVC Main)"}}}}}}}}}},"Guid":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"imdb://tt13303712"}}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1001},"message":{"type":"string","example":"User could not be authenticated"},"status":{"type":"number","example":401}}}}}}}}}},"method":"get","path":"/library/onDeck","servers":[{"url":"http://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}},{"url":"https://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"Token":[],"ClientIdentifier":[],"Device":[],"DeviceName":[],"Platform":[],"PlatformVersion":[],"Product":[],"Version":[]}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Get On Deck","description":{"content":"This endpoint will return the on deck content.\n","type":"text/plain"},"url":{"path":["library","onDeck"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: docs/plex-media-server/plex-api
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Get On Deck</h1>
<MethodEndpoint method={"get"} path={"/library/onDeck"}></MethodEndpoint>
This endpoint will return the on deck content.
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
The on Deck content
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>MediaContainer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":16}}></SchemaItem><SchemaItem collapsible={false} name={"allowSync"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"identifier"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"com.plexapp.plugins.library"}}></SchemaItem><SchemaItem collapsible={false} name={"mediaTagPrefix"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/system/bundle/media/flags/"}}></SchemaItem><SchemaItem collapsible={false} name={"mediaTagVersion"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1680021154}}></SchemaItem><SchemaItem collapsible={false} name={"mixedParents"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Metadata</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"allowSync"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionID"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"TV Shows"}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionUUID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"4bb2521c-8ba9-459b-aaee-8ab8bc35eabd"}}></SchemaItem><SchemaItem collapsible={false} name={"ratingKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":49564}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49564"}}></SchemaItem><SchemaItem collapsible={false} name={"parentRatingKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":49557}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentRatingKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":49556}}></SchemaItem><SchemaItem collapsible={false} name={"guid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"plex://episode/5ea7d7402e7ab10042e74d4f"}}></SchemaItem><SchemaItem collapsible={false} name={"parentGuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"plex://season/602e754d67f4c8002ce54b3d"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentGuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"plex://show/5d9c090e705e7a001e6e94d8"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"episode"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Circus"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49556"}}></SchemaItem><SchemaItem collapsible={false} name={"parentKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49557"}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/sections/2"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bluey (2018)"}}></SchemaItem><SchemaItem collapsible={false} name={"parentTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Season 2"}}></SchemaItem><SchemaItem collapsible={false} name={"contentRating"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"TV-Y"}}></SchemaItem><SchemaItem collapsible={false} name={"summary"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy."}}></SchemaItem><SchemaItem collapsible={false} name={"index"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":33}}></SchemaItem><SchemaItem collapsible={false} name={"parentIndex"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"lastViewedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1681908352}}></SchemaItem><SchemaItem collapsible={false} name={"year"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2018}}></SchemaItem><SchemaItem collapsible={false} name={"thumb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49564/thumb/1654258204"}}></SchemaItem><SchemaItem collapsible={false} name={"art"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49556/art/1680939546"}}></SchemaItem><SchemaItem collapsible={false} name={"parentThumb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49557/thumb/1654258204"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentThumb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49556/thumb/1680939546"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentArt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49556/art/1680939546"}}></SchemaItem><SchemaItem collapsible={false} name={"grandparentTheme"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/49556/theme/1680939546"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":420080}}></SchemaItem><SchemaItem collapsible={false} name={"originallyAvailableAt"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date","example":"2020-10-31T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"addedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1654258196}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1654258204}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Media</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":80994}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":420080}}></SchemaItem><SchemaItem collapsible={false} name={"bitrate"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1046}}></SchemaItem><SchemaItem collapsible={false} name={"width"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1920}}></SchemaItem><SchemaItem collapsible={false} name={"height"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1080}}></SchemaItem><SchemaItem collapsible={false} name={"aspectRatio"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1.78}}></SchemaItem><SchemaItem collapsible={false} name={"audioChannels"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"audioCodec"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"aac"}}></SchemaItem><SchemaItem collapsible={false} name={"videoCodec"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"hevc"}}></SchemaItem><SchemaItem collapsible={false} name={"videoResolution"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":1080}}></SchemaItem><SchemaItem collapsible={false} name={"container"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"videoFrameRate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"PAL"}}></SchemaItem><SchemaItem collapsible={false} name={"audioProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"lc"}}></SchemaItem><SchemaItem collapsible={false} name={"videoProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"main"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Part</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":80994}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/parts/80994/1655007810/file.mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":420080}}></SchemaItem><SchemaItem collapsible={false} name={"file"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":55148931}}></SchemaItem><SchemaItem collapsible={false} name={"audioProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"lc"}}></SchemaItem><SchemaItem collapsible={false} name={"container"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"videoProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"main"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Stream</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":211234}}></SchemaItem><SchemaItem collapsible={false} name={"streamType"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"default"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"codec"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"hevc"}}></SchemaItem><SchemaItem collapsible={false} name={"index"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"bitrate"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":918}}></SchemaItem><SchemaItem collapsible={false} name={"language"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"English"}}></SchemaItem><SchemaItem collapsible={false} name={"languageTag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"en"}}></SchemaItem><SchemaItem collapsible={false} name={"languageCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"eng"}}></SchemaItem><SchemaItem collapsible={false} name={"bitDepth"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":8}}></SchemaItem><SchemaItem collapsible={false} name={"chromaLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"left"}}></SchemaItem><SchemaItem collapsible={false} name={"chromaSubsampling"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":14520}}></SchemaItem><SchemaItem collapsible={false} name={"codedHeight"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1080}}></SchemaItem><SchemaItem collapsible={false} name={"codedWidth"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1920}}></SchemaItem><SchemaItem collapsible={false} name={"colorRange"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"tv"}}></SchemaItem><SchemaItem collapsible={false} name={"frameRate"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"height"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1080}}></SchemaItem><SchemaItem collapsible={false} name={"level"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":120}}></SchemaItem><SchemaItem collapsible={false} name={"profile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"main"}}></SchemaItem><SchemaItem collapsible={false} name={"refFrames"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"width"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1920}}></SchemaItem><SchemaItem collapsible={false} name={"displayTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"1080p (HEVC Main)"}}></SchemaItem><SchemaItem collapsible={false} name={"extendedDisplayTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"1080p (HEVC Main)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Guid</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"imdb://tt13303712"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"MediaContainer\": {\n \"size\": 16,\n \"allowSync\": true,\n \"identifier\": \"com.plexapp.plugins.library\",\n \"mediaTagPrefix\": \"/system/bundle/media/flags/\",\n \"mediaTagVersion\": 1680021154,\n \"mixedParents\": true,\n \"Metadata\": [\n {\n \"allowSync\": true,\n \"librarySectionID\": 2,\n \"librarySectionTitle\": \"TV Shows\",\n \"librarySectionUUID\": \"4bb2521c-8ba9-459b-aaee-8ab8bc35eabd\",\n \"ratingKey\": 49564,\n \"key\": \"/library/metadata/49564\",\n \"parentRatingKey\": 49557,\n \"grandparentRatingKey\": 49556,\n \"guid\": \"plex://episode/5ea7d7402e7ab10042e74d4f\",\n \"parentGuid\": \"plex://season/602e754d67f4c8002ce54b3d\",\n \"grandparentGuid\": \"plex://show/5d9c090e705e7a001e6e94d8\",\n \"type\": \"episode\",\n \"title\": \"Circus\",\n \"grandparentKey\": \"/library/metadata/49556\",\n \"parentKey\": \"/library/metadata/49557\",\n \"librarySectionKey\": \"/library/sections/2\",\n \"grandparentTitle\": \"Bluey (2018)\",\n \"parentTitle\": \"Season 2\",\n \"contentRating\": \"TV-Y\",\n \"summary\": \"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.\",\n \"index\": 33,\n \"parentIndex\": 2,\n \"lastViewedAt\": 1681908352,\n \"year\": 2018,\n \"thumb\": \"/library/metadata/49564/thumb/1654258204\",\n \"art\": \"/library/metadata/49556/art/1680939546\",\n \"parentThumb\": \"/library/metadata/49557/thumb/1654258204\",\n \"grandparentThumb\": \"/library/metadata/49556/thumb/1680939546\",\n \"grandparentArt\": \"/library/metadata/49556/art/1680939546\",\n \"grandparentTheme\": \"/library/metadata/49556/theme/1680939546\",\n \"duration\": 420080,\n \"originallyAvailableAt\": \"2020-10-31T00:00:00.000Z\",\n \"addedAt\": 1654258196,\n \"updatedAt\": 1654258204,\n \"Media\": [\n {\n \"id\": 80994,\n \"duration\": 420080,\n \"bitrate\": 1046,\n \"width\": 1920,\n \"height\": 1080,\n \"aspectRatio\": 1.78,\n \"audioChannels\": 2,\n \"audioCodec\": \"aac\",\n \"videoCodec\": \"hevc\",\n \"videoResolution\": 1080,\n \"container\": \"mkv\",\n \"videoFrameRate\": \"PAL\",\n \"audioProfile\": \"lc\",\n \"videoProfile\": \"main\",\n \"Part\": [\n {\n \"id\": 80994,\n \"key\": \"/library/parts/80994/1655007810/file.mkv\",\n \"duration\": 420080,\n \"file\": \"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv\",\n \"size\": 55148931,\n \"audioProfile\": \"lc\",\n \"container\": \"mkv\",\n \"videoProfile\": \"main\",\n \"Stream\": [\n {\n \"id\": 211234,\n \"streamType\": 1,\n \"default\": true,\n \"codec\": \"hevc\",\n \"index\": 0,\n \"bitrate\": 918,\n \"language\": \"English\",\n \"languageTag\": \"en\",\n \"languageCode\": \"eng\",\n \"bitDepth\": 8,\n \"chromaLocation\": \"left\",\n \"chromaSubsampling\": 14520,\n \"codedHeight\": 1080,\n \"codedWidth\": 1920,\n \"colorRange\": \"tv\",\n \"frameRate\": 25,\n \"height\": 1080,\n \"level\": 120,\n \"profile\": \"main\",\n \"refFrames\": 1,\n \"width\": 1920,\n \"displayTitle\": \"1080p (HEVC Main)\",\n \"extendedDisplayTitle\": \"1080p (HEVC Main)\"\n }\n ]\n }\n ]\n }\n ],\n \"Guid\": [\n {\n \"id\": \"imdb://tt13303712\"\n }\n ]\n }\n ]\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>errors</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1001}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"User could not be authenticated"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":401}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"errors\": [\n {\n \"code\": 1001,\n \"message\": \"User could not be authenticated\",\n \"status\": 401\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink