orchestrator
2021.10
false
- Getting Started
- Authentication
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
OUT OF SUPPORT
Orchestrator API Guide
Last updated Oct 31, 2024
Calendars Requests
The following GET request to the
/odata/Calendars endpoint retrieves a specific calendar based on its Name.
GET
{OrchestratorURL}/odata/Calendars?$filter=Name%20eq%20'BankHoliday'
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "BankHoliday",
"Id": 18845
}
]
}The following POST request to the
/odata/Calendars endpoint enables you to create a new calendar with an excluded date.
Note: The
Id parameter is automatically generated. The TimeZoneId parameter is populated with the tenant's timezone.
POST
{OrchestratorURL}/odata/Calendars
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "GTB Standard Time",
"ExcludedDates": [
"2019-11-12T00:00:00Z"
],
"Name": "VacationCal",
"Id": 32718
}The GET
/odata/Calendars({calendar_id_value}) endpoint retrieves the excluded dates of the specified calendar.
Use the calendar
Id to specify the calendar from which you want to retrieve the excluded dates.
To find out the
Ids of the existing calendars in your tenant, make a GET request to the /odata/Calendars endpoint first.
Identify the desired calendar and copy the
Id value from the response body.
GET
{OrchestratorURL}/odata/Calendars
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars",
"value": [
{
"TimeZoneId": null,
"ExcludedDates": [],
"Name": "November_excluded_dates",
"Id": 1461
}
]
}To see the excluded dates, make a GET request to the
/odata/Calendars({calendar_id_value}).
Replace
{calendar_id_value} with the previously copied Id value.
The response body returns all the dates that have been excluded in the specified calendar.
For example, for the calendar with the ID value of
1461, the request looks like below:
GET
{OrchestratorURL}/odata/Calendars(1461)
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "UTC",
"ExcludedDates": [
"2021-11-01T00:00:00Z",
"2021-11-04T00:00:00Z",
"2021-11-08T00:00:00Z",
"2021-11-11T00:00:00Z",
"2021-11-15T00:00:00Z",
"2021-11-18T00:00:00Z",
"2021-11-22T00:00:00Z",
"2021-11-25T00:00:00Z"
],
"Name": "November_excluded_dates",
"Id": 1461
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Calendars/$entity",
"TimeZoneId": "UTC",
"ExcludedDates": [
"2021-11-01T00:00:00Z",
"2021-11-04T00:00:00Z",
"2021-11-08T00:00:00Z",
"2021-11-11T00:00:00Z",
"2021-11-15T00:00:00Z",
"2021-11-18T00:00:00Z",
"2021-11-22T00:00:00Z",
"2021-11-25T00:00:00Z"
],
"Name": "November_excluded_dates",
"Id": 1461
}
