Skip to content
v3 API/
/
Calculate future occurren...

Calculate future occurrences based on the new schedules and the old frequencies

Request

GET /v3/schedules/calendar
Security
API_Key
Query
localStartDateTimestring

ISO-8601 Formatted date time implicitly in the user's local timezone (ex: YYYY-MM-DDTHH:MM:SS/2020-10-30T12:00:00)

localEndDateTimestring

ISO-8601 Formatted date time implicitly in the user's local timezone (ex: YYYY-MM-DDTHH:MM:SS/2020-10-30T12:00:00)

GET
/v3/schedules/calendar
curl -i -X GET \
  'https://api.observepoint.com/v3/schedules/calendar?localStartDateTime=string&localEndDateTime=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Get all data sources scheduled and future occurrences for provided params.

Bodyapplication/json
Array [
itemNamestring

Name of the scheduled item.

itemIdinteger

Item id of scheduled item.

itemTypestring

Type of data source item.

Enum:"AUDIT""WEB_JOURNEY"
runsArray of objects
futureOccurrencesArray of strings
folderIdinteger, (int32)

ID of a folder

Example:123
subFolderIdinteger

The ID of the subfolder under which the WebJourney/Audit is within.

userIdinteger

ID of a user

Example:123
labelsArray of integers, unique
isMonitoredByScriptServicesboolean

Whether the journey is monitored by script services.

scheduleobject

Schedule object with exception dates for the calendar endpoint.

]
Response
[
  {
    "itemName": "string",
    "itemId": 0,
    "itemType": "AUDIT",
    "runs": [ … ],
    "futureOccurrences": [ … ],
    "folderId": 123,
    "subFolderId": 0,
    "userId": 123,
    "labels": [ … ],
    "isMonitoredByScriptServices": true,
    "schedule": { … }
  }
]