Resource: Synchronizer Schedule Run ( /api/synchronizer/{linkId}/schedule/{id}/run )
Represents a run of a schedule for a synchornizer
Methods
POST
Trigger (Start) the schedule synchronizing immediately
Required Permissions
- Resources/ExternalLinks
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 202 - Accepted | Returned if the schedule was triggered. |
| 403 - Forbidden | Returned if the user does not have permission to add a new schedule. |
Example - Initiate synchronization immediately for a schedule
Update the schedule configuration
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {linkId} | 91c059b3-f0d8-4507-9d02-b80aa3df50f2 | ID of the ExternalSystemLink representing the synchronizer the schedule belongs to |
| {id} | bbd69b4e-4cfe-435d-8a5d-634a3cc11732 | ID of the schedule |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Status Code
202 - Accepted