Entity API
Jan 1 2022 at 12:00 AM
This service is responsible for storing Entity tree and entity metadata.
APIs within Entity API
Enitity API
API Calls
GetEntity
Permission
Entity or one of its descendants must have ENTITIES_GET permission.
Accessible
All. See response and accessibility information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000"
}
- entityId: text (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
GetEntityChildren
Permission
Entity or one of its descendants must have ENTITIES_GET permission.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntityChildren
URL Params
None
Data Params
{
"entityId":
"00000000-0000-0000-0000-000000000000"
}
- entityId: text (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
SubscribeToEntityEvents
Permission
ENTITIES_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/SubscribeToEntityEvents
URL Params
None
Data Params
{
"clientId":
"t000000000"
}
- clientId: text (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
UnsubscribeFromEntityEvents
Permission
No permission check.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UnsubscribeFromEntityEvents
URL Params
None
Data Params
{
"clientId":
"t000000000"
}
- clientId: text (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
GetBlueprint
Permission
BLUEPRINTS_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetBlueprint
URL Params
None
Data Params
{
"clientId": "t000000000",
"name": "Araptor"
}
- clientId: text (Required)
- name: text (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
GetBlueprints
Permission
BLUEPRINTS_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetBlueprints
URL Params
None
Data Params
{
"clientId": "t000000000",
}
- clientId: text (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
GetClientTags
Permission
TAGS_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetClientTags
URL Params
None
Data Params
{
"clientId": "t000000000",
}
- clientId: text (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
GetClientTagInfo
Permission
TAGS_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetClientTagInfo
URL Params
None
Data Params
{
"clientId": "t000000000",
}
- clientId: text (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
ClientHasTag
Permission
TAGS_GET on Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/ClientHasTag
URL Params
None
Data Params
{
"clientId": "t000000000",
"tag": "Blueprint GPS"
}
- clientId: text (Required)
- tag: text (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
GetClientTaggedEntities
Permission
TAGS_GET on Client Id.
Accessible
All
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetClientTaggedEntities
URL Params
None
Data Params
{
"clientId": "t000000000",
"tag": "Blueprint GPS",
"ancestorId": null,
"appliedtagsonly": false
}
- clientId: text (Required)
- tag: text (Required)
- ancestorId: text (Required)
- appliedtagsonly: bool (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
GetLogoUrl
Permission
Checks for Authorized client.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetLogoUrl
URL Params
None
Data Params
{
"clientId": "t000000000"
}
- clientId: text (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
GetFeatureFlagsForClient
Permission
Checks for Authorized client.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetFeatureFlagsForClient
URL Params
None
Data Params
{
"clientId": "t000000000"
}
- clientId: text (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
GetEntityPaths
Permission
ENTITIES_GET per Entity Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntityPaths
URL Params
None
Data Params
{
"entityIds": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
]
}
- entityIds: 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
ResolveBlueprintPropertiesForEntity
Permission
ENTITIES_GET for Entity Id and BLUEPRINTS_GET for Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/ResolveBlueprintPropertiesForEntity
URL Params
None
Data Params
{
"blueprint": "Test300Blu",
"entityId": "00000000-0000-0000-0000-000000000000"
}
blueprint: text (Required)
entityId: text (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
GetBlueprintPropertyEntities
Permission
BLUEPRINTS_GET for Client Id.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetBlueprintPropertyEntities
URL Params
None
Data Params
{
"clientId": "t000000000",
"blueprint": "Araptor",
"property": "Temperature",
"ancestorId": null
}
- clientId: text
- blueprint: text
- property: text
- ancestorId: text
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
GetEntitiesForEntityType
Permission
User must have explicit access to an entity.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntitiesForEntityType
URL Params
None
Data Params
{
"clientId": "t000000000",
"entityType": "Site"
}
- clientId: text
- entityType: text
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
GetAllFeatureFlags
Permission
No Permission Check
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetAllFeatureFlags
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
GetScopedVariables
Permission
No Permission Check
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetScopedVariables
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
SendGatewayScheduleNotificationToEdge
Permission
Checks for ENTITIES_CALENDAR_EDIT on calendarId.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/SendGatewayScheduleNotificationToEdge
URL Params
None
Data Params
{
"calendarId":"",
"notifyType":""
}
- alendarId: text
- notifyType: text
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
AddEntity
Permission
ENTITIES_{entityType}_ADD on Parent Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddEntity
URL Params
None
Data Params
{
"entity":
{
"EntityType": "Endpoint",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "TestEndpoint123"
}
}
- entityType: text (Required)
- parentId: text (Required)
- name: text (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
AddVirtualEndpoint
Permission
ENTITIES_GET on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddVirtualEndpoint
URL Params
None
Data Params
{
"clientId": "t000000000",
"parentId": "00000000-0000-0000-0000-000000000000",
"entityName": "testEntity"
}
- clientId: text (Required)
- parentId: text (Required)
- entityName: text (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
UpdateEntity
Permission
ENTITIES_{entityType}_EDIT on Entity Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UpdateEntity
URL Params
None
Data Params
{
"newData": {
"RowVersion": "00000000-0000-0000-0000-000000000000",
"PublishRoutingKey": "ENDPOINT.1. 00000000-0000-0000-0000-000000000000.NFY",
"StorageKey": "00000000-0000-0000-0000-000000000000",
"DataType": null,
"EntitySubType": "Normal",
"AllowNotificationsToTheEdge": true,
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "Endpoint",
"Ancestors": [
{
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "GroupEntity"
},
{
"EntityId": "t000000000",
"EntityType": "Client"
},
{
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "Root"
}
],
"Name": "EndpoiintPortalNEW",
"ParentId": "00000000-0000-0000-0000-000000000000",
"CanHaveChildren": true,
"AppliedBlueprints": [],
"DesiredBlueprints": [],
"Level": 3,
"Authorised": true
},
"oldData": {
"RowVersion": "00000000-0000-0000-0000-000000000000",
"PublishRoutingKey": "ENDPOINT.1. 00000000-0000-0000-0000-000000000000.NFY",
"StorageKey": "00000000-0000-0000-0000-000000000000",
"DataType": null,
"EntitySubType": "Normal",
"AllowNotificationsToTheEdge": true,
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "Endpoint",
"Ancestors": [
{
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "GroupEntity"
},
{
"EntityId": "t000000000",
"EntityType": "Client"
},
{
"EntityId": "00000000-0000-0000-0000-000000000000",
"EntityType": "Root"
}
],
"Name": "EndpoiintPortal",
"ParentId": "00000000-0000-0000-0000-000000000000",
"CanHaveChildren": true,
"AppliedBlueprints": [],
"DesiredBlueprints": [],
"Level": 3,
"Authorised": true
}
}
- newData: EntityObject (Required)
- oldData: EntityObject (Required)
- entityName: text (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
Needs FULL entity object for both oldData and newData as explained in the example. To get the full entity object call GetEntity with necessary parameters.
RemoveEntity
Permission
ENTITIES_{entityType}_DELETE on Entity Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/RemoveEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000"
}
- entityId: text (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
GetVersion
Permission
No Permission Check.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetVersion
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
AssociateGatewayAndClient
Permission
ENTITIES_ENDPOINTS_CLIENTASSOCIATEGATEWAYS on Client Id.
Accessible
Portal only.See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AssociateGatewayAndClient
URL Params
None
Data Params
{
"gatewayId": "00000000-0000-0000-0000-000000000000",
"clientId": "t000000000"
}
- gatewayId: text (Required)
- clientId: text (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
UnassociateGatewayAndClient
Permission
ENTITIES_ENDPOINTS_CLIENTASSOCIATEGATEWAYS on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UnassociateGatewayAndClient
URL Params
None
Data Params
{
"gatewayId": "00000000-0000-0000-0000-000000000000",
"clientId": "t000000000"
}
- gatewayId: text (Required)
- clientId: text (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
GetLinkedGatewaysForEntity
Permission
GATEWAYS_GET on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetLinkedGatewaysForEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000",
"includeChildren": true
}
- entityId: text (Required)
- includeChildren: bool (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
UnlinkGatewayPathAndEntity
Permission
ENTITIES_ENDPOINTS_CLIENTASSOCIATEGATEWAYS on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UnlinkGatewayPathAndEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000",
"gatewayPath": "TIMTEST-300.RAPTOR|TimTest-300:HEARTBEAT|1.value"
}
- entityId: text (Required)
- gatewayPath: text (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
LinkGatewayPathAndEntity
Permission
ENTITIES_ENDPOINTS_CLIENTASSOCIATEGATEWAYS on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/LinkGatewayPathAndEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000",
"gatewayPath": "TIMTEST-300.RAPTOR|TimTest-300:HEARTBEAT|1.value"
}
- entityId: text (Required)
- gatewayPath: text (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
GetUnlinkedGatewaysForClient
Permission
GATEWAYS_GET on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetUnlinkedGatewaysForClient
URL Params
None
Data Params
{
"clientId": "t000000000"
}
- clientId: text (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
GetLinkedGatewaysForClient
Permission
GATEWAYS_GET on Client Id
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetUnlinkedGatewaysForClient
URL Params
None
Data Params
{
"clientId": "t000000000"
}
- clientId: text (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
AddBlueprint
Permission
BLUEPRINTS_ADD on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddBlueprint
URL Params
None
Data Params
{
"entityBlueprint":
{
"clientId": "t000000000",
"blueprint": "Tim300Blu",
"property":
{
"PropertyName": "TEstProp",
"DataType": "String",
"Blueprint": "Tim300Blu"
}
}
}
- entityBlueprint: EntityBlueprint (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
RemoveBlueprint
Permission
BLUEPRINTS_DELETE on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/RemoveBlueprint
URL Params
None
Data Params
{
"clientId": "t000000000",
"name": "Tim300Blu"
}
- clientId: text (Required)
- name: text (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
AddBlueprintProperty
Permission
BLUEPRINTS_EDIT on Client Id.
Accessible
Portal only.See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddBlueprintProperty
URL Params
None
Data Params
{
"clientId": "t000000000",
"blueprint": "Tim300Blu",
"property": {
"PropertyName": "TEstProp",
"DataType": "String",
"Blueprint": "Tim300Blu"
}
- clientId: text (Required)
- blueprint: text (Required)
property: {
PropertyName: text, (Required)
Datatype: text, (Required)
Blueprint: text (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
UpdateBlueprintProperty
Permission
BLUEPRINTS_EDIT on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UpdateBlueprintProperty
URL Params
None
Data Params
{
"clientId": "t000000000",
"blueprint": "Tim300Blu",
"property": {
"PropertyName": "TEstProp",
"DataType": "String",
"Blueprint": "Tim300Blu"
}
clientId: text (Required)
blueprint: text (Required)
property: {
PropertyName: text (Required)
Datatype: text (Required)
Blueprint: text (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
RemoveBlueprintProperty
Permission
BLUEPRINTS_EDIT on Client Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/UpdateBlueprintProperty
URL Params
None
Data Params
{
"clientId": "t000000000",
"blueprint": "Tim300Blu",
"propertyName": "TEstProp2"
}
- clientId: text (Required)
- blueprint: text (Required)
- propertyName: text (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
MoveEntity
Permission
Checks for appropriate ADD on moveToParentId and appropriate DELETE on entityId’s parent.
Accessible
Portal only
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/MoveEntity
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000",
"moveToParentId": "00000000-0000-0000-0000-000000000000",
"position": -1
}
- entityId: text (Required)
- moveToParentId: text (Required)
- position: integer (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
GenerateBlueprintFromEntityGroup
Permission
BLUEPRINTS_ADD on Client Id and ENTITIES_GET on Entity Id and its children.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GenerateBlueprintFromEntityGroup
URL Params
None
Data Params
{
"clientId": "t000000000",
"entityId": "00000000-0000-0000-0000-000000000000",
"blueprintName": "Tim300Blu"
}
- clientId: text (Required)
- entityId: text (Required)
- blueprintName: text (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
SetTriggerEnabled
Permission
ENTITIES.TRIGGER_EDIT on every trigger.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/SetTriggerEnabled
URL Params
None
Data Params
{
"entityId": "00000000-0000-0000-0000-000000000000",
"enabled": true
}
- entityId: text (Required)
- enabled: bool (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
GetClientTriggers
Permission
ENTITIES.GET on every trigger.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetClientTriggers
URL Params
None
Data Params
{
"clientId": "t000000000"
}
- clientId: text (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
AddChildrenToParent
Permission
ENTITIES_{entityType}_ADD on Parent Id.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddChildrenToParent
URL Params
None
Data Params
{
"parentId": "00000000-0000-0000-0000-000000000000",
"children": [
{
"EntityType": "Endpoint",
"EntityId": "00000000-0000-0000-0000-000000000000",
"ParentId": "00000000-0000-0000-0000-000000000000",
"Name": "TestEndpoint123"
}
]
}
- parentId: text (Required)
- children: 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
PerformMaintenance
Permission
No Permission Check.
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/PasteClipboardItem
URL Params
None
Data Params
{
"action": "RemoveInvalidEntities",
"data": {}
}
- action: text (Required)
- data: object (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
RenameBlueprintProperty
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/RenameBlueprintProperty
URL Params
None
Data Params
{
"clientId": "string",
"blueprint":"string",
"oldPropertyName": "string",
"newPropertyName": "string",
"entitiesToApplyOn": ["string", "string"]
}
- clientId: string (Required)
- blueprint: string (Required)
- oldPropertyName: string (Required)
- newPropertyName: string (Required)
- entitiesToApplyOn: List
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
SetLogoUrl
Permission
Checks for authorised client.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/SetLogoUrl
URL Params
None
Data Params
{
"clientId": "string",
"logoUrl": "string"
}
- clientId: string (Required)
- logoUrl: 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
SetSiteAlias
Permission
Checks for authorised client.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/SetSiteAlias
URL Params
None
Data Params
{
"entityId": "123a12b3-6bf6-47a1-943a-05324b10e0e6",
"alias": "MySiteAlias"
}
- entityId: string (Required)
- alias: 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
GetClientTaggedEntityPaths
Permission
Entity or one of its descendants must have ENTITIES_GET right.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetClientTaggedEntityPaths
URL Params
None
Data Params
{
"clientId": "string",
"tag": "string",
"ancestorId": "string",
"appliedtagsonly": true
}
- clientId: string (Required)
- tag: string (Required)
- ancestorId: string
- appliedtagsonly: 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
GetEntities
Permission
entities:get
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntities
URL Params
None
Data Params
{
"entityIds": ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000" ]
}
- entityIds: 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
AddEntities
Permission
No permission check
Accessible
Tenant only.See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddEntities
URL Params
None
Data Params
{
"inputList": [
{
"EntityId":"string",
"UiMayEdit":true,
"ManagedBy":"string",
"Ancestors":{"EntityId":"string"},
"Name":"string",
"Description":"string",
"ParentId":"string",
"IdPath":"string",
"Children":["string", "string"],
"UsedByEntity":[{"EntityId":"string"},{"EntityId":"string"}],
"MetaData":[{"string":"object"}, {"string":"object"}],
"Tags": ["string", "string"],
"AppliedBlueprints":["string", "string"],
"DesiredBlueprints":["string", "string"],
"Level":2,
"Authorised":true
}
]
}
- inputList: 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
GetEntityIdFromPath
Permission
Checks for ENTITIES_GET on clientId.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntityIdFromPath
URL Params
None
Data Params
{
"entityPath": "string"
}
- entityPath: 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
GetEntitiesDescendantIds
Permission
No Permission check.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntitiesDescendantIds
URL Params
None
Data Params
{
" entityIds ": ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000000" ]
}
- entityPath: 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
PublishAllEntityNotifications
Permission
FULL ACCESS
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/PublishAllEntityNotifications
URL Params
None
Data Params
{
"clientId": "string",
"routableOnly": true,
"limitQty": 1,
"reply": true,
"staticOnly": true
}
- clientId: string (Required)
- routableOnly: bool
- limitQty: int?
- reply: bool
- staticOnly: 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
AddVirtualEndpoints
Permission
Checks for ENTITIES_GET on clientId.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/AddVirtualEndpoints
URL Params
None
Data Params
{
"virtualEndpoints": [
{
"ParentId":"string",
"Name":"string",
"EntityId":"string",
"Description":"string",
"EndpointDataType":"enum"
}
]
}
- virtualEndpoints: 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
GetEndpointsLinkedToGateway
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEndpointsLinkedToGateway
URL Params
None
Data Params
{
" gatewayId ": "00000000-0000-0000-0000-000000000000"
}
- gatewayId: 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
HasLinkedEndpointsForGateways
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/HasLinkedEndpointsForGateways
URL Params
None
Data Params
{
"gateways": [
{"GatewayId":"string"} , {"GatewayId":"string"}
]
}
- gateways: 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
HasLinkedEndpointsForGatewayDevices
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/HasLinkedEndpointsForGatewayDevices
URL Params
None
Data Params
{
"gatewayDevices": [
{"DeviceId":"string"} , {"DeviceId":"string"}
]
}
- gatewayDevices: 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
HasLinkedEndpointsForGatewayDeviceProperties
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/HasLinkedEndpointsForGatewayDeviceProperties
URL Params
None
Data Params
{
"gatewayDeviceProperties": [{"PropertyId":"string"} , {"PropertyId":"string"}
]
}
- gatewayDeviceProperties: 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
GetEntityTaggedEntityBlueprints
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntityTaggedEntityBlueprints
URL Params
None
Data Params
{
"entityId": "string"
}
entityId: 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
GetEntityTaggedEntityBlueprints
Permission
ENTITIES_GET
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/GetEntityTaggedEntityBlueprints
URL Params
None
Data Params
{
"entityId": "string"
}
- entityId: 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
Enitity API
API Calls
CopyEntities
Permission
ENTITIES_GET on Entity Id
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/CopyEntities
URL Params
None
Data Params
{
"entityIds": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
]
}
- entityIds: 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
CanPasteClipdoardItem
Permission
ENTITIES_GET on Entity Id
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/CanPasteClipdoardItem
URL Params
None
Data Params
{
"parentId": "b2b3ed48-1a7d-4269-93ef-aeb9c63a723b",
"clipboardItem": "testdata"
}
- parentId: text (Required)
- clipboardItem: text (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
PasteClipboardItem
Permission
ENTITIES_GET and ENTITIES_{entityType}_ADD on Parent Id
Accessible
Portal only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/PasteClipboardItem
URL Params
None
Data Params
{
"parentId": "b2b3ed48-1a7d-4269-93ef-aeb9c63a723b",
"clipboardItem": "testdata"
}
- parentId: text (Required)
- clipboardItem: text (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
CutEntities
Permission
Checks for ENTITIES_GET on entityIds.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/CutEntities
URL Params
None
Data Params
{
"entityIds": ["00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"]
}
- entityIds: 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
StartPaste
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/Entity/StartPaste
URL Params
None
Data Params
{
"parentId": "string",
"clipboardItem":"string"
}
- parentId: string (Required)
- clipboardItem: 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