In our platform, we use several objects in the application tree. List of all supported objects see below
...
We currently have the following objects:
folder - Folder used to group and structure other nodes. Example:
user - Guest user account with defined access rights.
camera - AXIS IP camera. The main device.
cashdesk - Item to store data from POS system.
dashboard - Display several cameras or charts on one screen.
device input - Device electric input - IO (doors are open/closed, cash drawer open/closed, …)
video channel - Video channel of a multichannel or panoramic camera. It works in a similar way as camera. You can fetch live view and recordings.
location - Similar as folder with some extra functionality. It represents one site e.g. store.
\uD83D\uDCD8 Tree items
The objects user, camera, electrical input, dashboard, folder and more are nodes in the tree structure. You can find all available types in the generated documentation in API Explorer.
...
This . Every node/item in the tree has a unique identifier called node_id . You can use also your own identifiers called external ids to refer specific camera or any other tree item.
The tree structure allows:
Get aggregated metrics from multiple objects.
Manage user permissions for a group of objects.
Organizing objects into groups for better clarity in the user interface.
| Info |
|---|
The folder object allows for endless immersion. Some objects, such as the electrical input, are always immersed under the camera object. |
...
Examples with objects:
List of all elements
...
Query:
| Code Block | ||
|---|---|---|
| ||
query {
nodeList {
parent_node_id
node_id
type
name
}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"nodeList": [
{
"parent_node_id": null,
"node_id": 138170,
"type": "folder",
"name": "rootfolder"
},
{
"parent_node_id": 138170,
"node_id": 138170,
"type": "folder",
"name": "San Diego"
},
...
]
}
} |
Example - camera type in nodeList:
If we want to get only objects of type "camera", we use the optional parameter type.
Query:
| Code Block | ||
|---|---|---|
| ||
query {
nodeList(type:camera) {
parent_node_id
type
name
node_id
}
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"nodeList": [
{
"parent_node_id": 138170,
"type": "camera",
"name": "ACCC8EE8A9CA",
"node_id": 140094
}
]
}
} |
...
folder - Folder used to group and structure other nodes.
...
user - Guest user account with defined access rights.
...
camera - AXIS camera, central item of the NetRex system.
...
box - Fast local storage and surveillance station in one.
...
gsmModem - Mobile GSM router
...
cameraAudioDevice - AXIS audio device, used to transmit audio messages to and from a camera.
...
cashdesk - User cashdesk
...
dataView - Data view. Used to display the gathered data (like visitor count or transactions) in a plot.
...
dashboard -
...
report - Data view. Used to display the gathered data (like visitor count or transactions) in a plot.
...
device input - Device electric input.
...
removedNode - A shell containing a removed node. Sometimes needed to preserve access to some of the nodes data.
...
videoChannel - VAPIX video channel of a multichannel or panoramic camera.
...
panel -
...
and type
| Anchor | ||||
|---|---|---|---|---|
|
\uD83D\uDCCB Related articles
...