Entity Tree API
Jan 1 2022 at 12:00 AM
This service is responsible for read-only traversing of the entity tree.
APIs within Entity Tree API
EntityTree
API Calls
Get
Permission
entities:get
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/Get
URL Params
None
Data Params
{
"entityId": "text"
}
- entityId: text (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
GetMany
Permission
entities:get
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/GetMany
URL Params
None
Data Params
{
"entityIds": ["text","text"]
}
- entityIds: List
(Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
Search
Permission
No permission checks.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/Search
URL Params
None
Data Params
{
"searchText": "string",
"entityType": "string",
"ancestorId": "string",
"thresholdId": "string",
"excludedTypes": ["string", "string"]
}
- searchText : string
- entityType : string
- ancestorId: string
- thresholdId: string
- excludedTypes: 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
SearchPaged
Permission
No permission checks.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/SearchPaged
URL Params
None
Data Params
{
"searchText": "string",
"entityType": "string",
"ancestorId": "string",
"thresholdId": "string",
"excludedTypes": ["string", "string"]
}
- searchText : string
- entityType : string
- ancestorId: string
- thresholdId: string
- -excludedTypes: 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
GetParents
Permission
No permission checks.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/GetParents
URL Params
None
Data Params
{
"entityId": "string",
"ancestorId": "string",
"entityTypes": ["string", "string"]
}
- entityId: string (Required)
- entityTypes: List
- ancestorId: 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
No permission checks.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/GetChildren
URL Params
None
Data Params
{
"entityId": "string",
"entityTypes": ["string", "string"]
}
- entityId: string (Required)
- entityTypes: 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
GetChildrenCountDetail
Permission
No permission checks.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/GetChildrenCountDetail
URL Params
None
Data Params
{
"entityId": "string"
}
- entityId: string (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
GetAllChildrenCountDetail
Permission
Full Access or Administrator.
Accessible
All. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityTree/GetChildrenCountDetail
URL Params
None
Data Params
{
"entityId": "string"
}
- entityId: string (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None