DeveloperAPI ReferenceLibrariesOptions
/api/libraries/options
Response Body
application/json
curl -X GET "https://example.com/api/libraries/options"{
"options": [
{
"pluginId": "string",
"pluginName": "string",
"pluginDescription": "string",
"pluginVersion": "string",
"pluginAuthor": "string",
"mediaTypes": [
"string"
],
"schema": {
"name": "string",
"icon": "string",
"description": "string",
"itemSchema": {
"type": "object",
"properties": {
"property1": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
},
"property2": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
}
}
},
"mediaTypes": [
"string"
],
"searchableFields": [
"string"
],
"filterableFields": [
"string"
],
"libraryViewBy": [
"string"
],
"libraryViewLabels": {
"property1": "string",
"property2": "string"
},
"display": {
"poster": {
"aspect": "square"
},
"heroBadges": {
"field": "string",
"format": "date"
}
},
"allowItemRematch": true,
"entitySchemas": {
"property1": {
"type": "object",
"properties": {
"property1": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
},
"property2": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
}
}
},
"property2": {
"type": "object",
"properties": {
"property1": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
},
"property2": {
"label": "string",
"widget": "text",
"editable": true,
"displayInEditor": true,
"displayInDetail": true,
"order": 0,
"entity": {
"type": "string",
"role": "string",
"splitOn": "name"
},
"type": "string"
}
}
}
},
"entityRenderers": {
"property1": {
"view": "horizontal-scroll",
"viewOptions": {
"groupBy": "string",
"sortBy": "string",
"groupLabel": "string",
"groupParam": "string",
"sortFormat": "number",
"source": "items",
"childType": "string",
"itemAspect": "landscape",
"dedupeItemSubtitle": true
},
"slots": {
"title": {
"field": "string",
"format": "date"
},
"parentTitle": {
"entityRole": "string",
"entityType": "string"
},
"subtitle": {
"field": "string",
"format": "date"
},
"caption": {
"field": "string",
"format": "date"
},
"chips": {
"field": "string",
"format": "date"
},
"overview": {
"field": "string",
"format": "date"
},
"rating": {
"field": "string",
"fallbackField": "string"
},
"poster": {
"prefer": [
"string"
]
},
"backdrop": {
"prefer": [
"string"
]
},
"links": {
"include": [
"canonicalIds"
]
},
"itemTitle": {
"field": "string",
"format": "date"
},
"itemSubtitle": {
"field": "string",
"format": "date"
},
"itemDescription": {
"field": "string",
"format": "date"
},
"itemThumbnail": {
"prefer": [
"string"
]
}
},
"extras": [
{
"type": "kv-grid",
"title": "string",
"fields": [
"string"
]
}
]
},
"property2": {
"view": "horizontal-scroll",
"viewOptions": {
"groupBy": "string",
"sortBy": "string",
"groupLabel": "string",
"groupParam": "string",
"sortFormat": "number",
"source": "items",
"childType": "string",
"itemAspect": "landscape",
"dedupeItemSubtitle": true
},
"slots": {
"title": {
"field": "string",
"format": "date"
},
"parentTitle": {
"entityRole": "string",
"entityType": "string"
},
"subtitle": {
"field": "string",
"format": "date"
},
"caption": {
"field": "string",
"format": "date"
},
"chips": {
"field": "string",
"format": "date"
},
"overview": {
"field": "string",
"format": "date"
},
"rating": {
"field": "string",
"fallbackField": "string"
},
"poster": {
"prefer": [
"string"
]
},
"backdrop": {
"prefer": [
"string"
]
},
"links": {
"include": [
"canonicalIds"
]
},
"itemTitle": {
"field": "string",
"format": "date"
},
"itemSubtitle": {
"field": "string",
"format": "date"
},
"itemDescription": {
"field": "string",
"format": "date"
},
"itemThumbnail": {
"prefer": [
"string"
]
}
},
"extras": [
{
"type": "kv-grid",
"title": "string",
"fields": [
"string"
]
}
]
}
},
"itemRenderer": {
"slots": {
"title": {
"field": "string",
"format": "date"
},
"parentTitle": {
"entityRole": "string",
"entityType": "string"
},
"subtitle": {
"field": "string",
"format": "date"
},
"caption": {
"field": "string",
"format": "date"
},
"chips": {
"field": "string",
"format": "date"
},
"overview": {
"field": "string",
"format": "date"
},
"rating": {
"field": "string",
"fallbackField": "string"
},
"poster": {
"prefer": [
"string"
]
},
"backdrop": {
"prefer": [
"string"
]
},
"links": {
"include": [
"canonicalIds"
]
},
"itemTitle": {
"field": "string",
"format": "date"
},
"itemSubtitle": {
"field": "string",
"format": "date"
},
"itemDescription": {
"field": "string",
"format": "date"
},
"itemThumbnail": {
"prefer": [
"string"
]
}
},
"extras": [
{
"type": "kv-grid",
"title": "string",
"fields": [
"string"
]
}
]
},
"watchedVerb": {
"done": "string",
"undo": "string",
"inProgress": "string"
},
"supportsContinueWatching": true,
"continueWatching": {
"title": {
"field": "string",
"format": "date"
},
"subtitle": {
"field": "string",
"format": "date"
}
}
}
}
]
}