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-search-results.api.mdx
Luke Hagar 9e0c39c66b dev changes
2023-04-20 07:50:46 -05:00

37 lines
31 KiB
Plaintext
Raw Blame History

---
id: get-search-results
sidebar_label: Get Search Results
hide_title: true
hide_table_of_contents: true
api: {"tags":["Search"],"description":"This will search the database for the string provided.","operationId":"getSearchResults","parameters":[{"name":"query","description":"The search query string to use","in":"query","schema":{"type":"string","example":110},"required":true}],"responses":{"200":{"description":"Search Results","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number","example":26},"identifier":{"type":"string","example":"com.plexapp.plugins.library"},"mediaTagPrefix":{"type":"string","example":"/system/bundle/media/flags/"},"mediaTagVersion":{"type":"number","example":1680021154},"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"},"personal":{"type":"boolean"},"sourceTitle":{"type":"string","example":"Hera"},"ratingKey":{"type":"string","example":10398},"key":{"type":"string","example":"/library/metadata/10398"},"guid":{"type":"string","example":"plex://movie/5d7768284de0ee001fcc8f52"},"studio":{"type":"string","example":"Paramount"},"type":{"type":"string","example":"movie"},"title":{"type":"string","example":"Mission: Impossible"},"contentRating":{"type":"string","example":"PG-13"},"summary":{"type":"string","example":"When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score."},"rating":{"type":"number","example":6.6},"audienceRating":{"type":"number","example":7.1},"year":{"type":"number","example":1996},"tagline":{"type":"string","example":"Expect the impossible."},"thumb":{"type":"string","example":"/library/metadata/10398/thumb/1679505055"},"art":{"type":"string","example":"/library/metadata/10398/art/1679505055"},"duration":{"type":"number","example":6612628},"originallyAvailableAt":{"type":"string","format":"date","example":"1996-05-22T00:00:00.000Z"},"addedAt":{"type":"number","example":1589234571},"updatedAt":{"type":"number","example":1679505055},"audienceRatingImage":{"type":"string","example":"rottentomatoes://image.rating.upright"},"chapterSource":{"type":"string","example":"media"},"primaryExtraKey":{"type":"string","example":"/library/metadata/10501"},"ratingImage":{"type":"string","example":"rottentomatoes://image.rating.ripe"},"Media":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":26610},"duration":{"type":"number","example":6612628},"bitrate":{"type":"number","example":4751},"width":{"type":"number","example":1916},"height":{"type":"number","example":796},"aspectRatio":{"type":"number","example":2.35},"audioChannels":{"type":"number","example":6},"audioCodec":{"type":"string","example":"aac"},"videoCodec":{"type":"string","example":"hevc"},"videoResolution":{"type":"string","example":1080},"container":{"type":"string","example":"mkv"},"videoFrameRate":{"type":"string","example":"24p"},"audioProfile":{"type":"string","example":"lc"},"videoProfile":{"type":"string","example":"main 10"},"Part":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","example":26610},"key":{"type":"string","example":"/library/parts/26610/1589234571/file.mkv"},"duration":{"type":"number","example":6612628},"file":{"type":"string","example":"/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv"},"size":{"type":"number","example":3926903851},"audioProfile":{"type":"string","example":"lc"},"container":{"type":"string","example":"mkv"},"videoProfile":{"type":"string","example":"main 10"}}}}}}},"Genre":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Action"}}}},"Director":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"Brian De Palma"}}}},"Writer":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","example":"David Koepp"}}}},"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":"Tom Cruise"}}}}}}},"Provider":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"/system/search"},"title":{"type":"string","example":"Local Network"},"type":{"type":"string","example":"mixed"}}}}}}}}}}},"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":"/search","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 Search Results","description":{"content":"This will search the database for the string provided.","type":"text/plain"},"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The search query string to use","type":"text/plain"},"key":"query","value":""}],"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 Search Results</h1>
<MethodEndpoint method={"get"} path={"/search"}></MethodEndpoint>
This will search the database for the string provided.
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"query","description":"The search query string to use","in":"query","schema":{"type":"string","example":110},"required":true}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Search Results
</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":26}}></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={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={"personal"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceTitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Hera"}}></SchemaItem><SchemaItem collapsible={false} name={"ratingKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":10398}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/10398"}}></SchemaItem><SchemaItem collapsible={false} name={"guid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"plex://movie/5d7768284de0ee001fcc8f52"}}></SchemaItem><SchemaItem collapsible={false} name={"studio"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Paramount"}}></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":"Mission: Impossible"}}></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":"When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score."}}></SchemaItem><SchemaItem collapsible={false} name={"rating"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":6.6}}></SchemaItem><SchemaItem collapsible={false} name={"audienceRating"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":7.1}}></SchemaItem><SchemaItem collapsible={false} name={"year"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1996}}></SchemaItem><SchemaItem collapsible={false} name={"tagline"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Expect the impossible."}}></SchemaItem><SchemaItem collapsible={false} name={"thumb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/10398/thumb/1679505055"}}></SchemaItem><SchemaItem collapsible={false} name={"art"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/metadata/10398/art/1679505055"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":6612628}}></SchemaItem><SchemaItem collapsible={false} name={"originallyAvailableAt"} required={false} schemaName={"date"} qualifierMessage={undefined} schema={{"type":"string","format":"date","example":"1996-05-22T00:00:00.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"addedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1589234571}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1679505055}}></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/10501"}}></SchemaItem><SchemaItem collapsible={false} name={"ratingImage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"rottentomatoes://image.rating.ripe"}}></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":26610}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":6612628}}></SchemaItem><SchemaItem collapsible={false} name={"bitrate"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":4751}}></SchemaItem><SchemaItem collapsible={false} name={"width"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1916}}></SchemaItem><SchemaItem collapsible={false} name={"height"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":796}}></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":"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":"24p"}}></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 10"}}></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":26610}}></SchemaItem><SchemaItem collapsible={false} name={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/library/parts/26610/1589234571/file.mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":6612628}}></SchemaItem><SchemaItem collapsible={false} name={"file"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":3926903851}}></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 10"}}></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":"Action"}}></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":"Brian De Palma"}}></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":"David Koepp"}}></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":"Tom Cruise"}}></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>Provider</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={"key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"/system/search"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Local Network"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"mixed"}}></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\": 26,\n \"identifier\": \"com.plexapp.plugins.library\",\n \"mediaTagPrefix\": \"/system/bundle/media/flags/\",\n \"mediaTagVersion\": 1680021154,\n \"Metadata\": [\n {\n \"allowSync\": true,\n \"librarySectionID\": 1,\n \"librarySectionTitle\": \"Movies\",\n \"librarySectionUUID\": \"322a231a-b7f7-49f5-920f-14c61199cd30\",\n \"personal\": true,\n \"sourceTitle\": \"Hera\",\n \"ratingKey\": 10398,\n \"key\": \"/library/metadata/10398\",\n \"guid\": \"plex://movie/5d7768284de0ee001fcc8f52\",\n \"studio\": \"Paramount\",\n \"type\": \"movie\",\n \"title\": \"Mission: Impossible\",\n \"contentRating\": \"PG-13\",\n \"summary\": \"When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score.\",\n \"rating\": 6.6,\n \"audienceRating\": 7.1,\n \"year\": 1996,\n \"tagline\": \"Expect the impossible.\",\n \"thumb\": \"/library/metadata/10398/thumb/1679505055\",\n \"art\": \"/library/metadata/10398/art/1679505055\",\n \"duration\": 6612628,\n \"originallyAvailableAt\": \"1996-05-22T00:00:00.000Z\",\n \"addedAt\": 1589234571,\n \"updatedAt\": 1679505055,\n \"audienceRatingImage\": \"rottentomatoes://image.rating.upright\",\n \"chapterSource\": \"media\",\n \"primaryExtraKey\": \"/library/metadata/10501\",\n \"ratingImage\": \"rottentomatoes://image.rating.ripe\",\n \"Media\": [\n {\n \"id\": 26610,\n \"duration\": 6612628,\n \"bitrate\": 4751,\n \"width\": 1916,\n \"height\": 796,\n \"aspectRatio\": 2.35,\n \"audioChannels\": 6,\n \"audioCodec\": \"aac\",\n \"videoCodec\": \"hevc\",\n \"videoResolution\": 1080,\n \"container\": \"mkv\",\n \"videoFrameRate\": \"24p\",\n \"audioProfile\": \"lc\",\n \"videoProfile\": \"main 10\",\n \"Part\": [\n {\n \"id\": 26610,\n \"key\": \"/library/parts/26610/1589234571/file.mkv\",\n \"duration\": 6612628,\n \"file\": \"/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv\",\n \"size\": 3926903851,\n \"audioProfile\": \"lc\",\n \"container\": \"mkv\",\n \"videoProfile\": \"main 10\"\n }\n ]\n }\n ],\n \"Genre\": [\n {\n \"tag\": \"Action\"\n }\n ],\n \"Director\": [\n {\n \"tag\": \"Brian De Palma\"\n }\n ],\n \"Writer\": [\n {\n \"tag\": \"David Koepp\"\n }\n ],\n \"Country\": [\n {\n \"tag\": \"United States of America\"\n }\n ],\n \"Role\": [\n {\n \"tag\": \"Tom Cruise\"\n }\n ]\n }\n ],\n \"Provider\": [\n {\n \"key\": \"/system/search\",\n \"title\": \"Local Network\",\n \"type\": \"mixed\"\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