Calendar Aggregate API
Jan 1 2022 at 12:00 AM
Acts as an aggregator that resolves the dependency of Calendar and CalendarEvents to enable easier use of the calendar’s master-detail relation.
APIs within Calendar Aggregate API
CalendarAggregate
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/CalendarAggregate/Search
URL Params
None
Data Params
Example:
{
"searchText": "text",
"limit": 21
}
searchText: string
limit: int? (optional)
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/CalendarAggregate/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/CalendarAggregate/AddCalendarEventException
URL Params
None
Data Params
Example:
"updatedMainCalendarEventData": {
"TreeInformation": {
"EntityId": "string",
"EntityType": "string",
"UiMayEdit": true,
"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": 1
}
},
"newEventExceptionData": {
"TreeInformation": {
"EntityId": "string",
"EntityType": "string",
"UiMayEdit": true,
"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": 1
}
}
updatedMainCalendarEventData: CalendarEventTreeEntity
newEventExceptionData: CalendarEventTreeEntity
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
AddCalendarEventTreeEntity
Permission
entities:edit
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarAggregate/AddCalendarEventTreeEntity
URL Params
None
Data Params
Example:
{
"entity": {
"TreeInformation": {
"EntityId": "string",
"EntityType": "string",
"UiMayEdit": true,
"Ancestors": {
"EntityId": "string"
},
"Path": "string",
"Name": "string",
"Description": "string",
"ParentId": "string",
"ClientId": "string",
"SiteId": "string",
"IdPath": "string",
"Children": "IReadOnlyCollection<string>",
"Tags": {"string""string"},
"AppliedBlueprints": "List<string>",
"DesiredBlueprints": {"string""string"},
"ManagedBy": "string",
"Level": "int"
}
}
}
-entity: CalendarEventTreeEntity
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
GetCalendarTreeEntity
Permission
entity access on entity
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarAggregate/GetCalendarTreeEntity
URL Params
None
Data Params
Example
{
"calendarId": "string",
"includeEvents": false
}
calendarId: string
includeEvents: bool (optional)
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
GetCalendarEventTreeEntity
Permission
entity access on entity
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarAggregate/GetCalendarEventTreeEntity
URL Params
None
Data Params
Example:
{
"eventId": "text"
}
- eventId: string
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
UpdateCalendarEventTreeEntity
Permission
entities:edit
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarAggregate/UpdateCalendarEventTreeEntity
URL Params
None
Data Params
Example:
{
"oldData": {
"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"
}
},
"newData": {
"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"
}
}
}
newData: CalendarEventTreeEntity
oldData: CalendarEventTreeEntity
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
RemoveCalendarEvent
Permission
entities:delete
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/CalendarAggregate/RemoveCalendarEvent
URL Params
None
Data Params
Example:
{
"eventId":"text"
}
- eventId: string
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