Commander API
Jan 1 2022 at 12:00 AM
The Commander™ service is used as the aggregator api between backend services / data and the Commander™ front-end. The Commander™ views are stored separately from EntityApi.
CommanderViews are JObjects that are interpreted by the front-end to determine how the dashboard should look and what it should be subscribed to. Entity level permissions are overwritten when the user has access to a view that represents the entity value in some form.
Prerequisites
Ensure the clientId and connection strings to relevant stored resources are setup correctly in the settings file.
Getting Started
Config
Apart from the RedGreenQueueAdapterOptions, there are a few required configuration items. These include:
- CommandeApi options
- MigrationManagerRepo options
Available APIs
Numerous APIs have been exposed within this service for maintainability of the code. They are:
- Commander™ Api
- Commander™ Config Api
- Commander™ Digitwin Api
- Commander™ Endpoint Data Api
- Commander™ Maintenance Api
- Commander™ Statistics Api
- Commander™ Userconfig Api
Commander™ Api
Maintain the widgets that are visible on the dashboard.
Commander™ Config Api
Crud operations of configuration relating to Commander Api. Configuration takes place in the Portal.
Commander™ Digitwin Api
Consumes the Digitwin Template and Digitwin Instance to provide digitwin details to calling user as well as to manage subscriptions.
LoadViewTemplate
Verifies that the template property submitted is part of a Digitwin template. If so and the view exists the view will be returned. If the view does not exist one will be created with the relevant information ie. Version, ManagedBy etc.
APIs within the Commander™ API
Commander™
API Calls
ChangeDesignMode
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeDesignMode
URL Params
None
Data Params
data:
{
"inDesignMode":"bool",
"viewId":"string"
}
-inDesignMode: bool (required)
-viewId: 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
GetVersion
Permission
no permission checks
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/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
NewView
Permission
No permission check
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/NewView
URL Params
None
Data Params
data:
{
"viewId":"string",
"ViewObj":
{
"ZoomLevel":"int",
"GridSpacing":"int",
"PathLevel":"int"
}
}
viewId: string (required)
viewObj: TreeBaseEntity.API.Abstractions.CommanderView (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
CreateViews
Permission
ENTITIES_VIEWS_ADD on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/CreateViews
URL Params
None
Data Params
data:
{
"ViewId": ["t000000000", "t000000000"],
"SendNotification": true
}
viewIds: List
(required) SendNotification: 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
LoadView
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/LoadView
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"subscribeToView": false
}
viewId: text (required)
subscribeToView: 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
AddViews
Permission
ENTITIES_VIEWS_ADD on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/AddViews
URL Params
None
Data Params
data:
{
"Views":
{
{
"RowVersion":"string",
"ViewId":"string",
"Version":"string",
"ManagedBy":"string",
"Tags":
{
"RowVersion":"string",
"TileConfig": JObject,
"PersistedTileContent": BSonDocument,
"PersistedTileContentConfig": BSonDocument
}
},{ }
},
"SendNotification": true
}
- Views : List
(required) - SendNotification: 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
ChangeViewConfig
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeViewConfig
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"oldData": "",
"newData": ""
}
viewId: text (required)
oldData: text (Complete view object – get the view object by calling LoadView function) (required)
newData: text (Complete view object – get the view object by calling LoadView function) (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
ChangeViewConfig.2
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeViewConfig
URL Params
None
Data Params
data:
{
"viewId":"string",
"currentRowVersion":"string",
"newData":"JObject"
}
viewId: string (required)
currentRowVersion: string (required)
newData: JObject (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
RemoveView
Permission
ENTITIES_VIEWS_DELETE on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/RemoveView
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"currentRowVersion": "string"
}
viewId: string (required)
currentRowVersion: 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
RemoveView.2
Permission
ENTITIES_VIEWS_DELETE on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/RemoveView
URL Params
None
Data Params
data:
{
"viewId ": "string",
"currentRowVersion": "string"
}
viewId : string (required)
currentRowVersion: 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
AddTiles
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/AddTiles
URL Params
None
Data Params
{
"NewTiles":List<
{
"viewId": "string",
"currentViewRowVersion": "string",
"Tiles": Dictionary< "string",
{
"RowVersion":"string",
"PersistedTileCOnfig":"BsonDocument",
"PersistedTileContent":"BsonDocument",
"PersistedTileContentConfig":"BsonDocument",
"TileSubscriptionConfig" : List<
{
"EntityId":"string",
"Children":"bool",
"BlueprintBindings": "BlueprintBinding[]",
"DigitwinBindings": "DigitwinBinding[]",
"DataTypes": "EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId": "string"
}>
}>
}>
}
- NewTiles: 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
AddTile.2
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/AddTile
URL Params
None
Data Params
{
" viewId ": "string",
"currentRowVersion": "string",
"newData" :
{
"RowVersion":"string",
"PersistedTileCOnfig":"BsonDocument",
"PersistedTileContent":"BsonDocument",
"PersistedTileContentConfig":"BsonDocument",
"TileSubscriptionConfig" : List<
{
"EntityId":"string",
"Children":"bool",
"BlueprintBindings":"BlueprintBinding[]",
"DigitwinBindings":"DigitwinBinding[]",
"DataTypes":"EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId":"string"
}
}
}
viewId : string (required)
currentRowVersion: string (required)
newData: Tile (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
AddTile
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/AddTile
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"maxTileId": 1,
"newData":
{
"tileConfig":
{
"lastValueShowDateTime": false,
"lastValueDateTimeFormat": "YYYY/MM/DD HH:mm:ss",
"cols": 2,
"rows": 2,
"y": 3,
"x": 6,
"resizeEnabled": false,
"pinned": false,
"showTitle": "raised",
"dragEnabled": false,
"minItemCols": 1,
"minItemRows": 1,
"title": "Single Value",
"mobileSupport": "all"
},
"tileContent":
{
"id": "IoTnxtSingleValueWidgetComponent",
"version": "3.5.5"
},
"tileContentConfig": {},
"tileSubscriptionConfig": {}
}
}
viewId: text (required)
maxTileId: text (required)
newData: text (Complete view object – get the view object by calling LoadView function) (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
ChangeTileConfig
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTileConfig
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"tileId": int,
"oldData":
{
"RowVersion":"string",
"PersistedTileConfig":"BsonDocument",
"TileConfig":"JObject",
"PersistedTileContent":"BsonDocument",
"TileContent":"JObject",
"PersistedTileContentConfig":"BsonDocument",
"TileSubscriptionConfig":
{
List<
{
"EntityId": "string",
"Children": true ,
"BlueprintBindings": "BlueprintBinding[]",
"DigitwinBindings": "DigitwinBinding[]",
"DataTypes": "EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId": "string"
}>
}
},
"newData":
{
List<
{
"EntityId": "string",
"Children": true ,
"BlueprintBindings": "BlueprintBinding[]",
"DigitwinBindings": "DigitwinBinding[]",
"DataTypes": "EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId": "string"
}>,
"subscribeToTile": true
}
}
viewId: text (required)
tileId: int (required)
oldData: Tile (Complete view object – get the view object by calling LoadView function) (required)
newData: Tile (Complete view object – get the view object by calling LoadView function) (required)
subscribeToTile: 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
ChangeTileConfigProperties
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTileConfigProperties
URL Params
None
Data Params
{
"viewId": "00000000-0000-0000-0000-000000000000",
"tileId": 2,
"oldData":
{
"tileContentConfig":
{
"settings":
{
"value":"0"
}
}
},
"newData":
{
"tileContentConfig":
{
"settings":
{
"value":"10"
}
}
},
"subscribeToTile": false
}
viewId: text (required)
tileId: int (required)
oldData: text (Complete view object – get the view object by calling LoadView function) (required)
newData: text (Complete view object – get the view object by calling LoadView function) (required)
subscribeToTile: 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
ChangeTileConfig.2
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/ChangeTileConfig
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 1,
"currentRowVersion":"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
ChangeTileConfigProperties.2
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/ChangeTileConfigProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 1,
"currentRowVersion": "string",
"newData": JObject,
"ubscribeToTile": "bool"
}
viewId : string (required)
data: text (Complete view object – get the view object by calling LoadView function) (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
ChangeTiles
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTiles
URL Params
None
Data Params
{
"tiles": List<
{
"viewId":"string",
"currentViewRowVersion":"string",
"Tiles": Dictionary<"string",
{
"RowVersion":"string",
"PersistedTileCOnfig":"BsonDocument",
"PersistedTileContent":"BsonDocument",
"PersistedTileContentConfig":"BsonDocument",
"TileSubscriptionConfig" : List<
{
"EntityId":"string",
"Children":"bool",
"BlueprintBindings":"BlueprintBinding[]",
"DigitwinBindings":"DigitwinBinding[]",
"DataTypes":" EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId":"string"
}>
}>
}>
}
- tiles: 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
RemoveTile
Permission
ENTITIES_VIEWS_EDIT on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/RemoveTile
viewId: text (required)
tileId: text (required)
oldData: text (Complete view object – get the view object by calling LoadView function) (required)
URL Params
None
Data Params
{
"viewId":"00000000-0000-0000-0000-000000000000",
"tileId":"00000000-0000-0000-0000-000000000000",
"oldData":
{
"tileContentConfig":
{
"settings":
{
"value":"10"
}
}
}
}
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
RemoveTile.2
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/RemoveTile
URL Params
None
Data Params
{
"viewId":"string",
"tileId": 1,
"currentRowVersion": "string"
}
viewId : string (required)
tileId: int (required)
currentRowVersion: 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
RemoveTiles
Permission
ENTITIES_VIEWS_EDIT on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/RemoveTiles
URL Params
None
Data Params
{
" tiles ":
[
{
"viewId": "string",
"CurrentRowVersion":"string",
"Tiles": Dictionary<"string", "string">
}
]
}
- tiles : List<BulkTileRemoveOperation> (required)
- tiles : 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
SubscribeToView
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToView
URL Params
None
Data Params
{
"viewId":"00000000-0000-0000-0000-000000000000"
}
- viewId: 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
UnsubscribeFromView
Permission
no permission checks
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnsubscribeFromView
URL Params
None
Data Params
{
"changesResubViewId": "string"
}
- changesResubViewId: 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
ChangeTileEndpointEntity
Permission
ENTITIES_GET on entityId
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTileEndpointEntity
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 2,
"tilePropertyId": "string",
"entityId": "string",
"subscribe": true
}
viewId: string
tileId: int
tilePropertyId: string
entityId: string
subscribe: 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
SetTilePropertyValue
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SetTilePropertyValue
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 2,
"tilePropertyId": "string",
"value": "object",
"blueprintEntityId": "string",
"expiresIn": "TimeSpan",
"durable": true
}
viewId: string (required)
tileId: int (required)
tilePropertyId: string (required)
value: object (required)
blueprintEntityId: string (required)
expiresIn:Timespan
durable: 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
ChangeBlueprintEntity
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeBlueprintEntity
URL Params
None
Data Params
{
"viewId": "string",
"blueprint": "string",
"entityId": "string",
"subscribe": true
}
viewId: string (required)
blueprint: string (required)
entityId: string (required)
subscribe: 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
ChangeBlueprintsEntity
Permission
ENTITIES_VIEWS_VIEW on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeBlueprintsEntity
URL Params
None
Data Params
{
"viewId":"string",
"blueprintEntityDetails": Dictionary<"string", "string">,
"subscribe": true,
}
- viewId: string (required)
- blueprintEntityDetails: Dictionary<string, string> (required)
- subscribe: 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
ChangeTileEndpointActiveBlueprintProperties
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTileEndpointActiveBlueprintProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 2,
"tileProperty": "string",
"blueprintPropertiesAndEntities": Dictionary<"string", "string">,
"subscribe": true
}
viewId: text (required)
tileId: int (required)
tileProperty: text (required)
blueprintPropertiesAndEntities : Dictionary<string, string> (required)
subscribe: 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
ResolveEntityPathsForViewTile
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ResolveEntityPathsForViewTile
URL Params
None
Data Params
{
"viewId ": "string",
"tileId ": 23,
"entityIds ": {"string", "string"}
}
viewId: text (required)
tileId: int (required)
entityIds: 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
UpdateTileSubscription
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UpdateTileSubscription
URL Params
None
Data Params
{
"viewId": "string",
"tileId": "string",
"oldSubscriptionConfig": List<
{
"EntityId": "string",
"Children": "bool",
"BlueprintBindings": "BlueprintBinding[]",
"DigitwinBindings": "DigitwinBinding[]",
"DataTypes": "EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId": "string"
}>
}
viewId: string (required)
tileId: string (required)
oldSubscriptionConfig: TileSubscriptionConfig (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
UpdateTilesSubscriptions
Permission
ENTITIES_VIEWS_VIEW on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UpdateTilesSubscription
URL Params
None
Data Params
{
" viewId ": "string",
"tileDetails":
[
{
"tileId": "string",
OldSubscriptionConfig:
{
"Endpoints":
[
{
"EntityId":"string",
"Children":"bool",
"BlueprintBindings":"BlueprintBinding[]",
"DigitwinBindings":"DigitwinBinding[]",
"DataTypes":" EntityEndpoint.API.Abstractions.Enums.EndpointDataType[]",
"CommanderTilePropertyId":"string"
}
]
}
}
]
}
- viewId : string
- tileDetails: TileSubscriptionDto[] 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
GetAggregatedHistoryDataForTileEndpoints
Permission
ENTITIES_VIEWS_VIEW on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetAggregatedHistoricalDataForTileEndpoints
URL Params
None
Data Params
{
"viewId ": "string",
"tileId":"string",
"dateFrom":"DateTime",
"dateTo": "DateTime",
"aggregateTypet": "AggregateType",
"interval": "TimeSpan",
"maxRenderedPoints": 1
}
viewId : string
tileId: string
dateFrom: DateTime
dateTo: DateTime
aggregateType: AggregateType
interval: TimeSpan
maxRenderedPoints: 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
GetUserViews
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetUserViews
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
GetCalendar
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetCalendar
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string",
"subscribeToEvents": true,
"subscribeToCalendar":true
}
viewId: text (required)
calenderId: text (required)
subscribeToEvents: bool
subscribeToCalendar: 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
ChangeCalendar
Permission
ENTITIES_VIEWS_EDIT on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeCalendar
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string",
"oldData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents":IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
}>
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers":"List<string>",
"ApprovedBy":"List<string>",
"Approved":"bool",
"OriginId":"string"
}>
},
}
"newData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents": IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers": List<"string">,
"ApprovedBy": List<"string">,
"Approved": "bool",
"OriginId": "string"
}>
}
}
}
viewId: text (required)
calenderId: text (required)
oldData: text (CalenderInfo Object) (required)
newData: text (CalenderInfo 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
ChangeCalendar.2
Permission
ENTITIES_VIEWS_VIEW on viewID
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeCalendar
URL Params
None
Data Params
{
"viewId ": "string",
"calendarId": "string",
"currentCalendarVersion": "string",
"newData":
{
"calendar": "calendarTreeEntity",
"calendarId": "string",
"rowVersion": "string",
"name": "string",
"description":"string",
"enabled": true,
"timeZone": "string",
"parentId": "string",
"DefaultEventDataType": "EndpointDataType",
"Events": Dictionary<"string", CalendarEventInfo>
}
}
viewId : string
calendarId: string
currentCalendarVersion: string
newData: CalendarInfo
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
AddCalendarEvent
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/AddCalendarEvent
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string",
"newData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents": IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers": List<"string">,
"ApprovedBy": List<"string">,
"Approved": "bool",
"OriginId": "string"
}>
}
}
}
viewId: text (required)
calenderId: text (required)
newData: text (CalenderInfo 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
AddCalendarEvent.2
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/AddCalendarEvent
URL Params
None
Data Params
{
"viewId": "string",
"calendarId": "string",
"currentCalendarRowVersion": "string",
"newData": CalendarEventInfo
}
viewId : string
calendarId: string
currentCalendarRowVersion: string
newData: CalendarEventInfo
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
ChangeCalendarEvent
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeCalendarEvent
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string",
"oldData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents":IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
}>
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers":"List<string>",
"ApprovedBy":"List<string>",
"Approved":"bool",
"OriginId":"string"
}>
},
}
"newData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents": IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers": List<"string">,
"ApprovedBy": List<"string">,
"Approved": "bool",
"OriginId": "string"
}>
}
}
}
viewId: text (required)
calendarEventId: text (required)
oldData: text (CalenderInfo Object) (required)
newData: text (CalenderInfo 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
ChangeCalendarEvent.2
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/ChangeCalendarEvent
URL Params
None
Data Params
{
"viewId": "string",
"calendarEventId": "string",
"currentCalendarEventRowVersion": "string",
"newData": CalendarEventInfo
}
viewId :string
calendarEventId: string
currentCalendarEventRowVersion: string
newData: CalendarEventInfo
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_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/RemoveCalendarEvent
URL Params
None
Data Params
"viewId": "string",
"calenderId": "string",
"oldData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents":IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
}>
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers":"List<string>",
"ApprovedBy":"List<string>",
"Approved":"bool",
"OriginId":"string"
}>
},
}
"newData":
{
"Calendar":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
},
"ChildrenEvents": IEnumerable<
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarId":"string",
"RowVersion":"string",
"Name":"string",
"Description":"string",
"Enabled":"bool",
"TimeZone":"string",
"ParentId":"string",
"DefaultEventDataType":
{
"EndpointDataType":"GPSCoordinate"
}
"Events": Dictionary<"string",
{
"CalendarEvent":
{
"TreeInformation":
{
"EntityId": "string",
"EntityType":"string",
"UiMayEdit":"bool",
"Ancestors":"EntityAncestors[]",
"Path":"string",
"Name":"string",
"Description":"string",
"ParentId":"string",
"ClientId":"string",
"SiteId":"string",
"IdPath":"string",
"Children":"IReadOnlyCollection<string>",
"RowVersion":"Guid?",
"Tags":"List<string>",
"AppliedBlueprints":"List<string>",
"DesiredBlueprints":"List<string>",
"ManagedBy":"string",
"Level":int
} >
},
"CalendarEventId":"string",
"RowVersion":"string",
"Enabled":"bool",
"Name":"string",
"Description":"string",
"StartDate":"DateTime",
"EndDate":"DateTime",
"RecurrenceRule":
{
"Expression":"string"
},
"RecurrenceException":"string",
"OnActive":"TriggerAction",
"OnReset":"TriggerAction",
"ParentId":"string",
"DataType":
{
"EndpointDataType": "GPSCoordinates"
},
"Status":
{
"CalendarEventStatus": "Pending"
},
"Message":"string",
"Colour":"string",
"Title":"string",
"Location":"string",
"Priority":int,
"ExtendedProperties":Dictionary<"string", "string">,
"Creator":"string",
"Organizer":"string",
"Approvers": List<"string">,
"ApprovedBy": List<"string">,
"Approved": "bool",
"OriginId": "string"
}>
}
}
}
viewId: text (required)
calenderEventId: text (required)
oldData: text (CalenderInfo 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
RemoveCalendarEvent.2
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/RemoveCalendarEvent
URL Params
None
Data Params
{
"viewId":"string",
"calendarEventId": "string",
"currentCalendarEventRowVersion":"string"
}
viewId : string
calendarEventId: string
currentCalendarEventRowVersion: 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
UnSubscribeFromCalendar
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnSubscribeFromCalendar
URL Params
None
Data Params
{
"calenderId": "string"
}
- calenderId: 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
SubscribeToCalendar
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToCalendar
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string"
}
viewId: text (required)
calenderId: 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
SubscribeToCalendarEvent
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToCalendarEvent
URL Params
None
Data Params
{
"viewId": "string",
"calenderId": "string"
}
viewId: text (required)
calenderId: 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
UnSubscribeFromCalendarEvent
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnSubscribeFromCalendarEvent
URL Params
None
Data Params
{
"calenderId": "string"
}
- calenderId: 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
GetBlueprintNames
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetBlueprintNames
URL Params
None
Data Params
{
"viewId": "string"
}
- viewId: 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
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v2/Commander/GetBluePrint
URL Params
None
Data Params
{
"viewId": "string",
"name":"string"
}
viewId: string
name: 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
GetClientTaggedEntityIds
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetClientTaggedEntityIds
URL Params
None
Data Params
{
"viewId": "string",
"tag": "string",
"ancestorId": "string",
"appliedTagsOnly": "bool"
}
viewId: 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
GetClientTaggedEntities
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetClientTaggedEntities
URL Params
None
Data Params
{
"viewId":"string",
"tag": "string",
"ancestorId":"string",
"appliedTagsOnly": true,
"bindingType": "string",
"includeChildren": true
}
viewId : string (required)
tag: string (required)
ancestorId: string (required)
appliedTagsOnly: bool (required)
bindingType: string (required)
includeChildren: 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
GetEntity
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetEntity
URL Params
None
Data Params
{
"viewId":"string",
"entityId": "string"
}
viewId : 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
GetEntities
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetEntities
URL Params
None
Data Params
{
"viewId":"string",
"entityIds": ["string","string"]
}
viewId : string (required)
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
ResolveBlueprintPropertiesForEntity
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ResolveBlueprintPropertiesForEntity
URL Params
None
Data Params
{
"viewId": "string",
"blueprint": "string",
"entityId": "string"
}
viewId : string (required)
blueprint: string (required)
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
GetEntitiesForEntityType
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetEntitiesForEntityType
URL Params
None
Data Params
{
"viewId": "string",
"entityType": "string"
}
viewId : string (required)
entityType: 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
GetTagHistory
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetTagHistory
URL Params
None
Data Params
{
"viewId": "string",
"tagId": "string",
"historyFrom": "DateTime",
"historyTo": "DateTime"
}
viewId : string (required)
tagId: string (required)
historyFrom: DateTime
historyTo: DateTime
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
PreviewCopyView
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/PreviewCopyView
URL Params
None
Data Params
{
"sourceViewId": "string",
"destinationViewId": "string"
}
sourceViewId : string (required)
destinationViewId: 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
CopyView
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/CopyView
URL Params
None
Data Params
{
"sourceViewId":"string",
"destinationViewIds": ["string", "string"]
}
sourceViewId : string (required)
destinationViewIds: 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
SubscribeToAlarmChangeContext
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToAlarmChangeContext
URL Params
None
Data Params
{
"viewId":"string",
"filteredId": "string"
}
viewId : string (required)
filteredId: 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
UnsubscribeFromAlarmChangeContext
Permission
no permission checks
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnsubscribeFromAlarmChangeContext
URL Params
None
Data Params
{
"viewId": "string",
"filteredId": "string"
}
viewId : string (required)
filteredId: 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
ResolveEntitiesForViewTile
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ResolveEntitiesForViewTile
URL Params
None
Data Params
{
"viewId":"string",
"tileId": 1,
"includeBlueprints":true,
"entityIds": ["string","string"]
}
viewId : string (required)
tileId: int (required)
includeBlueprints: bool (required)
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
SubscribeToTiles
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToTiles
URL Params
None
Data Params
{
"viewId": "string",
"tileIds": [1,2,3]
}
viewId : string (required)
tileIds: int[] (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
UnsubscribeFromTiles
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnsubscribeFromTiles
URL Params
None
Data Params
{
"viewId":"string",
"tileIds": {1,2,3}
}
viewId : string (required)
tileIds: int[] (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
GetAdhocServiceList
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetAdhocServiceList
URL Params
None
Data Params
{
"viewId":"string",
"serviceType":"string"
}
viewId : string (required)
serviceType: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
AddCalendareEventException
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/AddCalendareEventException
URL Params
None
Data Params
{
"viewId":"string",
"parentCalendarEventId": "string",
"currentParentCalendarEventRowVersion":"string",
"newParentEvent":"CalendarEventInfo",
"newExceptionEvent":"CalendarEventInfo"
}
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
SubscribeToBlueprintProperties
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToBlueprintProperties
URL Params
None
Data Params
{
"viewId":"string",
"tileId": 1,
"blueprintProperties": Dictionary<"string", {"string", "string"}>
}
viewId : string (required)
tileId: int (required)
blueprintProperties: 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
UnsubscribeFromBlueprintProperties
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnsubscribeFromBlueprintProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 2,
"blueprintProperties": {"string": ["string", "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
ResolveTaggedEntitiesAndPropertiesForBlueprints
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ResolveTaggedEntitiesAndPropertiesForBlueprints
URL Params
None
Data Params
{
"viewId":"string",
"blueprints": List<"string","string">
}
viewId : string (required)
blueprints: 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
ResolveTaggedEntitiesAndPropertiesForBindings
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ResolveTaggedEntitiesAndPropertiesForBindings
URL Params
None
Data Params
{
"viewId": "string",
"bindingType": "string",
"bindings": Dictionary<"string", {"string","string"}>,
"pageSize": 1,
"ThresholdId": "string",
"includeChildren": bool
}
viewId : string (required)
bindingType: string (required)
bindings: Dictionary<string, string[]> (required)
pageSize: int
thresholdId: string (required)
includeChildren: 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
ChangeBindingsEntity
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeBindingsEntity
URL Params
None
Data Params
{
"viewId":"string",
"subscribe": bool,
"bindingEntityDetails": Dictionary<"string", "string">
}
viewId : string (required)
subscribe: bool
bindingEntityDetails: 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
ChangeTileEndpointActiveBindingProperties
Permission
No permission check
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/ChangeTileEndpointActiveBindingProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 1,
"tileProperty": "string",
"bindingPropertiesAndEntities": Dictionary<"string", "string">,
"subscribe": true
}
viewId : string (required)
tileId: int (required)
tileProperty: string (required)
bindingPropertiesAndEntities: Dictionary<string, string> (required)
subscribe: 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
SubscribeToBindingProperties
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SubscribeToBindingProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 1,
"bindingProperties": Dictionary<"string", {"string","string"}>
}
viewId : string (required)
tileId: int (required)
bindingProperties: 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
UnsubscribeFromBindingProperties
Permission
No permission check
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/UnsubscribeFromBindingProperties
URL Params
None
Data Params
{
"viewId": "string",
"tileId": 1,
"bindingProperties": Dictionary<"string", {"string", "string"}>
}
viewId : string (required)
- tileId: int (required)
- bindingProperties: 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
SetSimulationConfig
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/SetSimulationConfig
URL Params
None
Data Params
{
"viewId":"string",
"simulationConfig":
{
"IntervalUnit":"string",
"DataPointCount":"int",
"InstanceCount":"int",
"Interval":"int",
"NumericRange":
{
"min":1,
"max":100
},
"Configured":true,
"GpsBoundary":
[
{
"Longitude": 123.2,
"Latitude":324.6,
"Altitude":1234.5
}
]
}
}
viewId : string (required)
simulationConfig: SimulationConfig (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
GetSimulationConfigAsync
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetSimulationConfigAsync
URL Params
None
Data Params
{
"viewId": "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
GetViewSubscriptionDetail
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetViewSubscriptionDetail
URL Params
None
Data Params
{
"viewId":"string"
}
- viewId: 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
GetTileSubscriptionDetails
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetTileSubscriptionDetails
URL Params
None
Data Params
{
"viewId":"string",
"tileIds": [2,3,4]
}
viewId: string
tileIds: 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
GetSubscriptionDetailValues
Permission
ENTITIES_VIEWS_VIEW on viewId
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetSubscriptionDetailValues
URL Params
None
Data Params
{
"viewId": "string",
"subscriptionList":
{
"tileId":1,
"objectIds":Dictionary<string,
{
"LimitExceeded":true,
"EndpointIds": List<"string">
}>,
"Endpoints": Dictionary<"string",
{
"EntryTime": "DateTime",
"Value": object
}>
},
"endpointsOfInterest": ["string","string"]
}
viewId: string (required)
subscriptionList: SubscriptionResults (required)
endpointsOfInterest: 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
IsClickThroughEnabledForView
Permission
ENTITIES_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/IsClickThroughEnabledForView
URL Params
None
Data Params
{
"viewId": "string"
}
- viewId: 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_VIEWS_VIEW on View Id
Accessible
Tenant Only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/Commander/GetEntityPaths
URL Params
None
Data Params
{
"viewId": "string",
"entityIds": ["string", "string"]
}
viewId: text (required)
entityIds: 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