Calendar API
Jan 1 2022 at 12:00 AM
The Calender API contains API calls for read-only operations on Calender entities.
APIs within Calendar API
Calendar
API Calls
Search
Permission
entity access on entities
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Calendar/Search
URL Params
NONE
Data Params
{
“searchText”: “string”,
“limit”: 1000
}
searchText: string (required)
limit: int
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
All
Permission
entity access on entities
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Calendar/All
URL Params
NONE
Data Params
NONE
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None
AddCalendarEventException
Permission
entities:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Calendar/AddCalendarEventException
URL Params
NONE
Data Params
{
"updatedMainCalendarEventData": {
"TreeInformation": {
"EntityId": "string",
"EntityType": "string",
"UiMayEdit": "bool",
"Ancestors": {
"EntityId": "string"
},
"Path": "string",
"Name": "string",
"Description": "string",
"ParentId": "string",
"ClientId": "string",
"SiteId": "string",
"IdPath": "string",
"Children": "IReadOnlyCollection<string>",
"Tags": {"string", "string"},
"AppliedBlueprints": {"string", "string"},
"DesiredBlueprints": {"string", "string"},
"ManagedBy": "string",
"Level": "int"
}
},
"newEventExceptionData": {
"TreeInformation": {
"EntityId": "string",
"EntityType": "string",
"UiMayEdit": "bool",
"Ancestors": {
"EntityId": "string"
},
"Path": "string",
"Name": "string",
"Description": "string",
"ParentId": "string",
"ClientId": "string",
"SiteId": "string",
"IdPath": "string",
"Children": "IReadOnlyCollection<string>",
"Tags": {"string", "string"},,
"AppliedBlueprints": {"string", "string"},
"DesiredBlueprints": {"string", "string"},
"ManagedBy": "string",
"Level": "int"
}
}
}
updatedMainCalendarEventData: CalendarEventEntity (required)
newEventExceptionData: CalendarEventEntity (required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more
Notes
None