Date: Fri, 29 Mar 2024 01:06:11 +0000 (UTC) Message-ID: <1051160789.10329.1711674371496@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_10328_297785040.1711674371495" ------=_Part_10328_297785040.1711674371495 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Represents a single schedule associated with a synchronization configura= tion
This resource supports the following methods: DELETE, GET= a>, PATCH, PUT
Delete a schedule
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
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 sy= nchronizer 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=3Dutf-8 |
Status Code
200 - OK
Retrieves information about a schedule
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if you do not have permission to view t= his 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 sy= nchronizer the schedule belongs to |
{id} | bbd69b4e-4cfe-435d-8a5d-634a3cc11732 | ID of the schedule |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "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-b80aa3= df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732" }
Status Code
200 - OK
Patch an existing schedule (currently you can only patch the Enabled sta= tus property)
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if you do not have permission to update= this resource. |
Example of using PATCH to disable the schedule. Note: Currently PATCH on= ly 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 sy= nchronizer the schedule belongs to |
{id} | bbd69b4e-4cfe-435d-8a5d-634a3cc11732 | ID of the schedule |
Request Body
{ "Ena= bled": false }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "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-b80aa3= df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732" }
Status Code
200 - OK
Update an existing schedule
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
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 sy= nchronizer the schedule belongs to |
{id} | bbd69b4e-4cfe-435d-8a5d-634a3cc11732 | ID of the schedule |
Request Body
{ "Configuration": { "PeriodInMinutes": 15, "Type": "Periodic" }, "Direction": "SourceToDestination", "Scope": "SynchronizeUpdated", "Condition": "AllEntities", "Enabled": true }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "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-b80aa3= df50f2/schedules/bbd69b4e-4cfe-435d-8a5d-634a3cc11732" }
Status Code
200 - OK