orchestrator
2020.10
false
Orchestrator API Guide
- Getting Started
- Swagger Definition
- Orchestrator APIs
- 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
Retrieving Calendars According to Their Name
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'
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Response code
200 OK
Response body
{
"@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
}
]
}
Creating a Calendar
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
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Request body
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
{
"Name": "VacationCal",
"TimeZoneId": "string",
"ExcludedDates": [
"2019-11-12T14:31:44.778Z"
]
}
Response code
200 OK
Response body
{
"@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
}