postItemsRemotesearchApplyById
Applies search criteria to an item and refreshes metadata
Requires authentication as administrator
postItemsRemotesearchApplyById
Request
post /Items/RemoteSearch/Apply/{Id}Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *Id | path | The item id |
||
| ReplaceAllImages | query | Whether or not to replace all images |
||
| *body | body | RemoteSearchResult | RemoteSearchResult: |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Operation successful. Empty response. |
||
| 400 | Bad Request. Server cannot process request. |
||
| 401 | Unauthorized. Client needs to authenticate. |
||
| 403 | Forbidden. No permission for the reqested operation. |
||
| 404 | Resource not found or unavailable. |
||
| 500 | Server error. |
Definitions
RemoteSearchResult
| Name | Type | Notes |
|---|---|---|
| Name | string | The name. |
| OriginalTitle | string | |
| ProviderIds | ProviderIdDictionary | |
| ProductionYear | integer (int32) | The year. |
| IndexNumber | integer (int32) | |
| IndexNumberEnd | integer (int32) | |
| ParentIndexNumber | integer (int32) | |
| SortIndexNumber | integer (int32) | |
| SortParentIndexNumber | integer (int32) | |
| PremiereDate | string (date-time) | |
| StartDate | string (date-time) | |
| EndDate | string (date-time) | |
| ImageUrl | string | |
| SearchProviderName | string | |
| GameSystem | string | |
| Overview | string | |
| DisambiguationComment | string | |
| AlbumArtist | ||
| Artists | array |