Resource: Synchronizer Schedules ( /api/synchronizer/{id}/schedules )

Represents a collection of schedules associated with a synchronization configuration

This resource supports the following methods: GET, POST

Methods

GET

Retrieves information about a synchronizer's schedules

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

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).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if you do not have permission to view this resource.

Example - Get All Schedules for a Synchronizer (External System Link)

Example of retrieving a schedule

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}91c059b3-f0d8-4507-9d02-b80aa3df50f2ID of the ExternalSystemLink (synchronizer) to retrieve schedules for

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "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"
    },
    {
      "Configuration": {
        "Type": "AdHoc"
      },
      "Direction": "SourceToDestination",
      "Scope": "SynchronizeUpdated",
      "Condition": "AllEntities",
      "LinkId": "91c059b3-f0d8-4507-9d02-b80aa3df50f2",
      "Id": "437246d4-c1ec-4da2-a4a7-2371847a1be1",
      "Description": "Ad-hoc; Synchronizing to External System; Synchronize Updates",
      "Enabled": true,
      "IsRunning": false,
      "StatusMessage": "Idle",
      "LastRun": null,
      "NextRun": null,
      "Self": "http://localhost/api/synchronizer/91c059b3-f0d8-4507-9d02-b80aa3df50f2/schedules/437246d4-c1ec-4da2-a4a7-2371847a1be1"
    }
  ],
  "Self": "http://localhost/api/api/synchronizer/91C059B3-F0D8-4507-9D02-B80AA3DF50F2/schedules"
}

Status Code

200 - OK

POST

Create a new schedule for the synchronizer

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).

StatusDescription
201 - CreatedReturned if the new schedule was created successfully.
403 - ForbiddenReturned if the user does not have permission to add a new schedule.

Example - Create a new Schedule

Create a new schedule for the synchronizer (External System Link).

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}91c059b3-f0d8-4507-9d02-b80aa3df50f2ID of the ExternalSystemLink (synchronizer) to add a schedule to

Request Body

{
  "Configuration": {
    "PeriodInMinutes": 15,
    "Type": "Periodic"
  },
  "Direction": "SourceToDestination",
  "Scope": "SynchronizeUpdated",
  "Condition": "AllEntities",
  "Enabled": true
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8
Locationhttp://localhost/api/synchronizer/91C059B3-F0D8-4507-9D02-B80AA3DF50F2/schedule/BBD69B4E-4CFE-435D-8A5D-634A3CC11732

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": "Idle",
  "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

201 - Created

  • No labels