Resource: Synchronizer Schedule ( /api/synchronizer/{linkId}/schedule/{id} )
Represents a single schedule associated with a synchronization configuration
This resource supports the following methods: DELETE, GET, PATCH, PUT
Methods
DELETE
Delete a schedule
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 |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to delete this resource. |
Example of deleting a schedule
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 to remove |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Status Code
200 - OK
GET
Retrieves information about a schedule
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 |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to view this resource. |
Example of retrieving a schedule
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 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"Direction": "SourceToDestination",
"Scope": "SynchronizeUpdated",
"Condition": "AllEntities",
"LinkId": "91c059b3-f0d8-4507-9d02-b80aa3df50f2",
"Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
"Description": "Periodic (repeating every 15 minutes); Synchronizing from External System; Synchronize Updates",
"Enabled": true,
"IsRunning": false,
"StatusMessage": "Synchronization Completed (Started At: 5/10/2012 12:36:52 p.m., Duration: 00:00:00.0810046)",
"LastRun": "2012-10-04T23:36:00Z",
"NextRun": "2012-10-04T23:51:00Z",
"Self": "http://localhost/api/synchronizer/91c059b3-f0d8-4507-9d02-b80aa3df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732"
}
|
Status Code
200 - OK
PATCH
Patch an existing schedule (currently you can only patch the Enabled status property)
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 |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to update this resource. |
Example of using PATCH to disable the schedule. Note: Currently PATCH only supports changing the 'Enabled' status
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 |
Request Body
| Code Block | ||
|---|---|---|
| ||
{ "Enabled": false }
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"Direction": "SourceToDestination",
"Scope": "SynchronizeUpdated",
"Condition": "PreviouslySynchronized",
"LinkId": "91c059b3-f0d8-4507-9d02-b80aa3df50f2",
"Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
"Description": "Periodic (repeating every 15 minutes); Synchronizing from External System; Synchronize Updates; Previously Synchronized Only",
"Enabled": false,
"IsRunning": false,
"StatusMessage": "Synchronization Completed (Started At: 5/10/2012 12:36:52 p.m., Duration: 00:00:00.0810046)",
"LastRun": "2012-10-04T23:36:00Z",
"NextRun": "2012-10-04T23:51:00Z",
"Self": "http://localhost/api/synchronizer/91c059b3-f0d8-4507-9d02-b80aa3df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732"
}
|
Status Code
200 - OK
PUT
Update an existing schedule
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 |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you do not have permission to update this resource. |
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 |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"Direction": "SourceToDestination",
"Scope": "SynchronizeUpdated",
"Condition": "AllEntities",
"Enabled": true
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Configuration": {
"PeriodInMinutes": 15,
"Type": "Periodic"
},
"Direction": "SourceToDestination",
"Scope": "SynchronizeUpdated",
"Condition": "AllEntities",
"LinkId": "91c059b3-f0d8-4507-9d02-b80aa3df50f2",
"Id": "bbd69b4e-4cfe-435d-8a5d-634a3cc11732",
"Description": "Periodic (repeating every 15 minutes); Synchronizing from External System; Synchronize Updates",
"Enabled": true,
"IsRunning": false,
"StatusMessage": "Synchronization Completed (Started At: 5/10/2012 12:36:52 p.m., Duration: 00:00:00.0810046)",
"LastRun": "2012-10-04T23:36:00Z",
"NextRun": "2012-10-04T23:51:00Z",
"Self": "http://localhost/api/synchronizer/91c059b3-f0d8-4507-9d02-b80aa3df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732"
}
|
Status Code
200 - OK