Tree Base Entity API

Jan 1 2022 at 12:00 AM

APIs within Tree Base Entity API
1. TreeBaseEntity
  1. API Calls

The Tree Base Entity API is responsible for maintaining tree entities by providing functionality to Add, Remove, and Retrieve tree entities.

APIs within Tree Base Entity API

TreeBaseEntity

API Calls

GetBatchedDescendents

Permission

Checks Entity Path Access and “entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetBatchedDescendents

URL Params

None

Data Params

{
    "path": "string",
    "lastFetchedId": "string",
    "batchSize": 100
} 

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

Get

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/Get

URL Params

None

Data Params

{
	"Id": "string"
} 

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

GetChildren

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetChildren

URL Params

None

Data Params

{
	"Id": "string"
} 

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

GetMany

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetMany

URL Params

None

Data Params

Example:
{
	"Ids": {"string", "string"}
} 

Ids: 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

GetNext

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetNext

URL Params

None

Data Params

{
	"lastFetchedId": "string" 
	"count": 1000 
} 

lastFetchedId: string
count: 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

GetEntityPaths

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetEntityPaths

URL Params

None

Data Params

Example:
{
	"entityIds": {"string", "string"}
} 

entityIds: 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

GetEntityIdPaths

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetEntityIdPaths

URL Params

None

Data Params

Example:
{
	"entityIds": {"string", "string"}
}

entityIds: string[]

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Add

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/Add

URL Params

None

Data Params

Example:
{
  "data": {
    "EntityId": "string",
    "UiMayEdit": "bool",
    "ManagedBy": "string",
    "Ancestors": {
      "EntityId": "string"
    },
    "Name": "string",
    "Description": "string",
    "ParentId": "string",
    "IdPath": "string",
    "Tags": "List<string>",
    "Level": "int",
    "Children": "IReadOnlyCollection<string>",
    "Authorised": "bool"
  }
} 

data: TreeEntity

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

AddMany

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/AddMany

URL Params

None

Data Params

Example:
{
  "data": {
    {
      "EntityId": "string",
      "UiMayEdit": "bool",
      "ManagedBy": "string",
      "Ancestors": {
			  "EntityId": "string"
		  },
      "Name": "string",
      "Description": "string",
      "ParentId": "string",
      "IdPath": "string",
      "Tags": {"string","string"},
      "Level": "int",
      "Children": "IReadOnlyCollection<string>",
      "Authorised": "bool"
    }
  }
}

data: 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

AddManyManaged

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/AddManyManaged

URL Params

None

Data Params

Example:
{
  "data": {
    {
      "EntityId": "string",
      "UiMayEdit": "bool",
      "ManagedBy": "string",
      "Ancestors": {
        "EntityId": "string"
      },
      "Name": "string",
      "Description": "string",
      "ParentId": "string",
      "IdPath": "string",
      "Tags": {"string","string"},
      "Level": "int",
      "Children": "IReadOnlyCollection<string>",
      "Authorised": "bool"
    }
  }
}

data: 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

Update

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/Update

URL Params

None

Data Params

Example:
{
  "newData": {
    "EntityId": "string",
    "UiMayEdit": "bool",
    "ManagedBy": "string",
    "Ancestors": {
      "EntityId": "string"
    },
    "Name": "string",
    "Description": "string",
    "ParentId": "string",
    "IdPath": "string",
    "Tags": {"string","string"},
    "Level": "int",
    "Children": "IReadOnlyCollection<string>",
    "Authorised": "bool"
  },
  "oldRowVersion": "Guid"
}

newData: TreeEntity
oldRowVersion: Guid

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

UpdateMany

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/UpdateMany

URL Params

None

Data Params

{
    "newData": 
    {
      {
        "newData" {
          "EntityId":"string",
          "UiMayEdit":true,
          "ManagedBy":"string",
          "Ancestors":{"EntityId":"string"},
          "Name":"string",
          "Description":"string",
          "ParentId":"string",
          "IdPath":"string",
          "Tags":{"string", "string"},
          "Level":3,
          "Children":IReadOnlyCollection<"string">,
          "Authorised":true}, 
          "oldRowVersion": "Guid"
          },
        { 
         "newData": {"EntityId":"string",
          "UiMayEdit":true,
          "ManagedBy":"string",
          "Ancestors":{"EntityId":"string"},
          "Name":"string",
          "Description":"string",
          "ParentId":"string",
          "IdPath":"string",
          "Tags":{"string", "string"},
          "Level":3,
          "Children":IReadOnlyCollection<"string">,
          "Authorised":true}, 
          "oldRowVersion": "Guid"
          }
    }
}

newData: List<Entities.Common.UpdateModel<Guid, TreeEntity»

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

UpdateManyManaged

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/UpdateManyManaged

URL Params

None

Data Params

{
    "newData": 
    {
        {
         "newData": {"EntityId":"string",
          "UiMayEdit":true,
          "ManagedBy":"string",
          "Ancestors":{"EntityId":"string"},
          "Name":"string",
          "Description":"string",
          "ParentId":"string",
          "IdPath":"string",
          "Tags":{"string", "string"},
          "Level":3,
          "Children":IReadOnlyCollection<"string">,
          "Authorised":true}, 
          "oldRowVersion": "Guid"
          },
    {
         "newData": {"EntityId":"string",
          "UiMayEdit":true,
          "ManagedBy":"string",
          "Ancestors":{"EntityId":"string"},
          "Name":"string",
          "Description":"string",
          "ParentId":"string",
          "IdPath":"string",
          "Tags":{"string", "string"},
          "Level":3,
          "Children":IReadOnlyCollection<"string">,
          "Authorised":true}, 
          "oldRowVersion": "Guid"
          }
    }
}

newData: List<Entities.Common.UpdateModel<Guid, TreeEntity»

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

Remove

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/Remove

URL Params

None

Data Params

{
  "Id": "string" 
} 

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

RemoveMany

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/RemoveMany

URL Params

None

Data Params

Example:
{
  "ids": {"string","string"}
}

ids: 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

RemoveManaged

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/RemoveManaged

URL Params

None

Data Params

Example:
{
  "ids": {"string","string"}
}

ids: 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

MoveEntity

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/MoveEntity

URL Params

None

Data Params

Example:
{
  "entityId": "string" ,
  "moveToParentId": "string" ,
  "position" : 3 
}

entityId: string
moveToParentId: string
position : int (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

MoveManagedEntity

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/MoveManagedEntity

URL Params

None

Data Params

Example:
{
  "entityId": "string" ,
  "moveToParentId": "string" ,
  "position" : 3 
}

entityId: string
moveToParentId: string
position : int (optional)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more

Error Response

Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more

Notes

None

SubscribeToEntityEvents

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/SubscribeToEntityEvents

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

UnsubscribeFromEntityEvents

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/UnsubscribeFromEntityEvents

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

GetEntityType

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetEntityType

URL Params

None

Data Params

{
  "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

GetManyEntityType

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/GetManyEntityType

URL Params

None

Data Params

Example:
{
  "entityIds": {"string", "string"}
}

entityIds: IEnumerable

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

ResolveAssociatedViewIdForSite

Permission

Checks Entity Path Access and entities:get

Accessible

Tenant only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/TreeBaseEntity/ResolveAssociatedViewIdForSite

URL Params

None

Data Params

{
  "siteId": "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

SetSiteAlias

Permission

checks for authorized 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

Example:
{
  "messageType": "Entity.SetSiteAlias",
  "entityId": "123a12b3-6bf6-47a1-943a-05324b10e0e6",
  "alias": "MySiteAlias"
}

entityId: string
alias: 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

Tree Base Entity API

APIs within Tree Base Entity API

TreeBaseEntity

API Calls

Continue reading

Community

Questions

Website