Calendar Event API
Jan 1 2022 at 12:00 AM
This service is responsible for mangaging calender event entities and their metadata.
APIs within Calendar Event API
EntityCalendarEvent
API Calls
Get
Permission
entities:get
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/Get
URL Params
None
Data Params
data:
{
"id": "text"
}
- id: 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
GetMany
Permission
Entities:get
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/GetMany
URL Params
None
Data Params
data:
{
"ids": ["text", "text"]
}
- ids: List
(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
GetNext1000
Permission
Entities:get
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/GetNext1000
URL Params
None
Data Params
data:
{
"lastFetchedId": "string"
}
- lastFetchedId: 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
Add
Permission
Entities.calendar_events:add
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendar/Get
URL Params
None
Data Params
data:
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
- data: 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
AddMany
Permission
Entities.calendar_events:add
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/AddMany
URL Params
None
Data Params
data:
{
[
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
},
]
}
- data: List
(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
Update
Permission
Entities.calendar_events:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/Update
URL Params
None
Data Params
data:
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
}
- data: UpdateModel
(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
UpdateMany
Permission
Entities.calendar:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendar/UpdateMany
URL Params
None
Data Params
data:
{
[
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
},
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
}
]
}
- data: List<UpdateModel
> (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
AddOrUpdate
Permission
Entities.calendar_events:add
Entities.calendar_events:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/AddOrUpdate
URL Params
None
Data Params
data:
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
}
- data: UpdateModel
(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
AddOrUpdateMany
Permission
Entities.calendar:edit
Entities.calendar:ad
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/AddOrUpdateMany
URL Params
None
Data Params
data:
{
[
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
},
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"routingKey": "string",
"gatewayPath": "string",
"publishRoutingKey": "string",
"storageKey": null,
"delayDuration": 0,
"ActivateCondition":
{
"DataType":"Undefined"(enum)
},
"OnActivate": TriggerAction,
"OnReset": TriggerAction,
"ResetCondition":
{
"DataType":"Undefined"(enum)
},
"valueTimeout": 0,
"enabled": false,
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"DataType": "Undefined"(enum),
"PublishRoutingKeyEntityType": "Default"(enum),
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"RecurrenceRule":
{
"Expression":"string"
},
"recurrenceException": "string",
"creator": "string",
"organizer": "string",
"approvers": ["string", "string"],
"approvedBy": ["string", "string"],
"title": "string",
"location": "string",
"priority": 0,
"extendedProperties":
{
"string":"string"
},
"originId": "string",
"Status ": "string",
"SystemLastChangedBy ": " Pending"(enum),
"lastChangedUTCDateTimeStamp": "datetime",
"message": "string",
"colour": "string"
}
}
]
}
- data: List<UpdateModel
> (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
Remove
Permission
Entities.calendar_events:delete
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/Remove
URL Params
None
Data Params
data:
{
"id": "text"
}
- id: string (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
Copy
Permission
Entities.calendar_events:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/Copy
URL Params
None
Data Params
data:
{
"masterId": "string",
"targetId": "string"
}
masterId: string (required)
targetId: 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
CopyMany
Permission
Entities.calendar_events:edit
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/CopyMany
URL Params
None
Data Params
{
"masterToTargetIds": {
"MasterIDstring": "TargetIDstring",
"MasterIDstring": "TargetIDstring",
"MasterIDstring": "TargetIDstring"
}
}
- masterToTargetIds: Dictionary<string, string> (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
RemoveMany
Permission
Entities.calendar_events:delete
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityCalendarEvent/RemoveMany
URL Params
None
Data Params
{
"ids":
[
"string",
"string"
]
}
- ids: List
(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