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
9e0c39c66bcd0ec90e22290b5731a774927c2d1c
plex-docs/docs/plex-media-server/get-recently-added.api.mdx
Luke Hagar 9e0c39c66b dev changes
2023-04-20 07:50:46 -05:00

38 lines
30 KiB
Plaintext
Raw Blame History

---
id: get-recently-added
sidebar_label: Get Recently Added
hide_title: true
hide_table_of_contents: true
api: {"tags":["Library"],"description":"This endpoint will return the recently added content.\n","operationId":"getRecentlyAdded","responses":{"200":{"description":"The recently added content","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number","example":50},"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":1},"librarySectionTitle":{"type":"string","example":"Movies"},"librarySectionUUID":{"type":"string","example":"322a231a-b7f7-49f5-920f-14c61199cd30"},"ratingKey":{"type":"string","example":59398},"key":{"type":"string","example":"/library/metadata/59398"},"guid":{"type":"string","example":"plex://movie/5e161a83bea6ac004126e148"},"studio":{"type":"string","example":"Marvel Studios"},"type":{"type":"string","example":"movie"},"title":{"type":"string","example":"Ant-Man and the Wasp: Quantumania"},"contentRating":{"type":"string","example":"PG-13"},"summary":{"type":"string","example":"Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible."},"rating":{"type":"number","example":4.7},"audienceRating":{"type":"number","example":8.3},"year":{"type":"number","example":2023},"tagline":{"type":"string","example":"Witness the beginning of a new dynasty."},"thumb":{"type":"string","example":"/library/metadata/59398/thumb/1681888010"},"art":{"type":"string","example":"/library/metadata/59398/art/1681888010"},"duration":{"type":"number","example":7474422},"originallyAvailableAt":{"type":"string","format":"date","example":"2023-02-15T00:00:00.000Z"},"addedAt":{"type":"number","example":1681803215},"updatedAt":{"type":"number","example":1681888010},"audienceRatingImage":{"type":"string","example":"rottentomatoes://image.rating.upright"},"chapterSource":{"type":"string","example":"media"},"primaryExtraKey":{"type":"string","example":"/library/metadata/59399"},"ratingImage":{"type":"string","example":"rottentomatoes://image.rating.rotten"},"Media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":120345},"duration":{"type":"number","example":7474422},"bitrate":{"type":"number","example":3623},"width":{"type":"number","example":1920},"height":{"type":"number","example":804},"aspectRatio":{"type":"number","example":2.35},"audioChannels":{"type":"number","example":6},"audioCodec":{"type":"string","example":"ac3"},"videoCodec":{"type":"string","example":"h264"},"videoResolution":{"type":"string","example":1080},"container":{"type":"string","example":"mp4"},"videoFrameRate":{"type":"string","example":"24p"},"optimizedForStreaming":{"type":"number","example":0},"has64bitOffsets":{"type":"boolean"},"videoProfile":{"type":"string","example":"high"},"Part":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":120353},"key":{"type":"string","example":"/library/parts/120353/1681803203/file.mp4"},"duration":{"type":"number","example":7474422},"file":{"type":"string","example":"/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4"},"size":{"type":"number","example":3395307162},"container":{"type":"string","example":"mp4"},"has64bitOffsets":{"type":"boolean"},"hasThumbnail":{"type":"string","example":1},"optimizedForStreaming":{"type":"boolean"},"videoProfile":{"type":"string","example":"high"}}}}}}},"Genre":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Comedy"}}}},"Director":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Peyton Reed"}}}},"Writer":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Jeff Loveness"}}}},"Country":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"United States of America"}}}},"Role":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Paul Rudd"}}}}}}}}}}}}}},"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/recentlyAdded","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 Recently Added","description":{"content":"This endpoint will return the recently added content.\n","type":"text/plain"},"url":{"path":["library","recentlyAdded"],"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 Recently Added</h1>
<MethodEndpoint method={"get"} path={"/library/recentlyAdded"}></MethodEndpoint>
This endpoint will return the recently added content.
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
The recently added 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":50}}></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":1}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Movies"}}></SchemaItem><SchemaItem collapsible={false} name={"librarySectionUUID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"322a231a-b7f7-49f5-920f-14c61199cd30"}}></SchemaItem><SchemaItem collapsible={false} name={"ratingKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":59398}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/59398"}}></SchemaItem><SchemaItem collapsible={false} name={"guid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"plex://movie/5e161a83bea6ac004126e148"}}></SchemaItem><SchemaItem collapsible={false} name={"studio"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Marvel Studios"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"movie"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Ant-Man and the Wasp: Quantumania"}}></SchemaItem><SchemaItem collapsible={false} name={"contentRating"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"PG-13"}}></SchemaItem><SchemaItem collapsible={false} name={"summary"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible."}}></SchemaItem><SchemaItem collapsible={false} name={"rating"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":4.7}}></SchemaItem><SchemaItem collapsible={false} name={"audienceRating"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":8.3}}></SchemaItem><SchemaItem collapsible={false} name={"year"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2023}}></SchemaItem><SchemaItem collapsible={false} name={"tagline"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Witness the beginning of a new dynasty."}}></SchemaItem><SchemaItem collapsible={false} name={"thumb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/59398/thumb/1681888010"}}></SchemaItem><SchemaItem collapsible={false} name={"art"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/59398/art/1681888010"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":7474422}}></SchemaItem><SchemaItem collapsible={false} name={"originallyAvailableAt"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date","example":"2023-02-15T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"addedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1681803215}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1681888010}}></SchemaItem><SchemaItem collapsible={false} name={"audienceRatingImage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"rottentomatoes://image.rating.upright"}}></SchemaItem><SchemaItem collapsible={false} name={"chapterSource"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"media"}}></SchemaItem><SchemaItem collapsible={false} name={"primaryExtraKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/59399"}}></SchemaItem><SchemaItem collapsible={false} name={"ratingImage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"rottentomatoes://image.rating.rotten"}}></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":120345}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":7474422}}></SchemaItem><SchemaItem collapsible={false} name={"bitrate"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":3623}}></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":804}}></SchemaItem><SchemaItem collapsible={false} name={"aspectRatio"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":2.35}}></SchemaItem><SchemaItem collapsible={false} name={"audioChannels"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":6}}></SchemaItem><SchemaItem collapsible={false} name={"audioCodec"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"ac3"}}></SchemaItem><SchemaItem collapsible={false} name={"videoCodec"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"h264"}}></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":"mp4"}}></SchemaItem><SchemaItem collapsible={false} name={"videoFrameRate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"24p"}}></SchemaItem><SchemaItem collapsible={false} name={"optimizedForStreaming"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"has64bitOffsets"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"videoProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"high"}}></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":120353}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/parts/120353/1681803203/file.mp4"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":7474422}}></SchemaItem><SchemaItem collapsible={false} name={"file"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":3395307162}}></SchemaItem><SchemaItem collapsible={false} name={"container"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"mp4"}}></SchemaItem><SchemaItem collapsible={false} name={"has64bitOffsets"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"hasThumbnail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"optimizedForStreaming"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"videoProfile"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"high"}}></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>Genre</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={"tag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Comedy"}}></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>Director</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={"tag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Peyton Reed"}}></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>Writer</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={"tag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Jeff Loveness"}}></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>Country</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={"tag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"United States of America"}}></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>Role</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={"tag"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Paul Rudd"}}></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\": 50,\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\": 1,\n \"librarySectionTitle\": \"Movies\",\n \"librarySectionUUID\": \"322a231a-b7f7-49f5-920f-14c61199cd30\",\n \"ratingKey\": 59398,\n \"key\": \"/library/metadata/59398\",\n \"guid\": \"plex://movie/5e161a83bea6ac004126e148\",\n \"studio\": \"Marvel Studios\",\n \"type\": \"movie\",\n \"title\": \"Ant-Man and the Wasp: Quantumania\",\n \"contentRating\": \"PG-13\",\n \"summary\": \"Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible.\",\n \"rating\": 4.7,\n \"audienceRating\": 8.3,\n \"year\": 2023,\n \"tagline\": \"Witness the beginning of a new dynasty.\",\n \"thumb\": \"/library/metadata/59398/thumb/1681888010\",\n \"art\": \"/library/metadata/59398/art/1681888010\",\n \"duration\": 7474422,\n \"originallyAvailableAt\": \"2023-02-15T00:00:00.000Z\",\n \"addedAt\": 1681803215,\n \"updatedAt\": 1681888010,\n \"audienceRatingImage\": \"rottentomatoes://image.rating.upright\",\n \"chapterSource\": \"media\",\n \"primaryExtraKey\": \"/library/metadata/59399\",\n \"ratingImage\": \"rottentomatoes://image.rating.rotten\",\n \"Media\": [\n {\n \"id\": 120345,\n \"duration\": 7474422,\n \"bitrate\": 3623,\n \"width\": 1920,\n \"height\": 804,\n \"aspectRatio\": 2.35,\n \"audioChannels\": 6,\n \"audioCodec\": \"ac3\",\n \"videoCodec\": \"h264\",\n \"videoResolution\": 1080,\n \"container\": \"mp4\",\n \"videoFrameRate\": \"24p\",\n \"optimizedForStreaming\": 0,\n \"has64bitOffsets\": true,\n \"videoProfile\": \"high\",\n \"Part\": [\n {\n \"id\": 120353,\n \"key\": \"/library/parts/120353/1681803203/file.mp4\",\n \"duration\": 7474422,\n \"file\": \"/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4\",\n \"size\": 3395307162,\n \"container\": \"mp4\",\n \"has64bitOffsets\": true,\n \"hasThumbnail\": 1,\n \"optimizedForStreaming\": true,\n \"videoProfile\": \"high\"\n }\n ]\n }\n ],\n \"Genre\": [\n {\n \"tag\": \"Comedy\"\n }\n ],\n \"Director\": [\n {\n \"tag\": \"Peyton Reed\"\n }\n ],\n \"Writer\": [\n {\n \"tag\": \"Jeff Loveness\"\n }\n ],\n \"Country\": [\n {\n \"tag\": \"United States of America\"\n }\n ],\n \"Role\": [\n {\n \"tag\": \"Paul Rudd\"\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