Entity Function API
Jan 1 2022 at 12:00 AM
This service is responsible for mangaging function entities and their metadata.
APIs within Entity Function API
EntityFunction
API Calls
Get
Permission
Checks Entity Path Access and “entities:get”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/Get
URL Params
NONE
Data Params
{
"id": "string"
}
- 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
GetMany
Permission
Checks Entity Path Access and “entities:get”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/GetMany
URL Params
NONE
Data Params
{
"ids": List<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
GetNext1000
Permission
Checks permission “entities:global_get”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/GetNext1000
URL Params
NONE
Data Params
{
"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
Checks Entity Path Access and “entities.calendar:add”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/Add
URL Params
NONE
Data Params
{
"data":
{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
- data: EntityFunction (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
Checks Entity Path Access and “entities.calendar:add”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/AddMany
URL Params
NONE
Data Params
{
"data":
{
{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
}
- 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
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/Update
URL Params
NONE
Data Params
{
"data": {
"OldDataRowVersion":"string",
"NewData":{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
}
data: UpdateModel
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
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/UpdateMany
URL Params
NONE
Data Params
{
"data":
{
"OldDataRowVersion":"string",
"NewData":
{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
}
data: List<UpdateModel
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
Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/AddOrUpdate
URL Params
NONE
Data Params
{
"data": {
"OldDataRowVersion":"string",
"NewData":{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
}
- 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
Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/AddOrUpdateMany
URL Params
NONE
Data Params
{
"data": {
"OldDataRowVersion":"string",
"NewData":{
"id": "string",
"rowVersion": "string",
"managedBy": "string",
"isValid": false,
"enabled": false,
"publishRoutingKey": "string",
"publishRoutingKeyEntityType": "Default" (enum)
}
}
}
- 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
Checks Entity Path Access and “entities.calendar:delete”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/Remove
URL Params
NONE
Data Params
{
id:"string",
}
- 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
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/Copy
URL Params
NONE
Data Params
{
"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
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/CopyMany
URL Params
NONE
Data Params
{
"masterToTargetIds": {"string": "string", "string": "string"}
}
- 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
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/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
PerformMaintenanceOnFunctionsByName
Permission
FULL ACCESS OR ADMIN ROLE
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/PerformMaintenanceOnFunctionsByName
URL Params
NONE
Data Params
{
"functionName": "string",
"newIsValid": true
}
functionName: string (required)
newIsValid: bool
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
PerformMaintenance
Permission
FULL ACCESS
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityFunction/PerformMaintenance
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