postSyncJobsById
Updates a sync job.
Requires authentication as user
postSyncJobsById
Request
post /Sync/Jobs/{Id}
Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *Id | path | |||
| *body | body | SyncJob | SyncJob: |
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
SyncJob
see also MediaBrowser.Model.Sync.SyncJob
| Name | Type | Notes |
|---|---|---|
| Id | integer (int64) | The identifier. |
| TargetId | string | The device identifier. |
| InternalTargetId | integer (int64) | |
| TargetName | string | The name of the target. |
| Quality | string | The quality. |
| Bitrate | integer (int32) | The bitrate. |
| Container | string | |
| VideoCodec | string | |
| AudioCodec | string | |
| Profile | string | The profile. |
| Category | SyncCategory | |
| ParentId | integer (int64) | The parent identifier. |
| Progress | number (double) | The current progress. |
| Name | string | The name. |
| Status | SyncJobStatus | |
| UserId | integer (int64) | The user identifier. |
| UnwatchedOnly | boolean | A value indicating whether [unwatched only]. |
| SyncNewContent | boolean | A value indicating whether [synchronize new content]. |
| ItemLimit | integer (int32) | The item limit. |
| RequestedItemIds | array | The requested item ids. |
| ItemId | integer (int64) | |
| DateCreated | string (date-time) | The date created. |
| DateLastModified | string (date-time) | The date last modified. |
| ItemCount | integer (int32) | The item count. |
| ParentName | string | |
| PrimaryImageItemId | string | |
| PrimaryImageTag | string |
SyncCategory
see also MediaBrowser.Model.Sync.SyncCategory
Enum Values
- Latest
- NextUp
- Resume
SyncJobStatus
Enum Values
- Queued
- Converting
- ReadyToTransfer
- Transferring
- Completed
- CompletedWithError
- Failed