In our platform, we use several objects in the application tree.

...

• folder - Folder used to group and structure other nodes. Example:

• user - Guest user account with defined access rights.

• camera - AXIS IP camera, central item of the NetRex system. Example: download rec and play live

• box - Fast local storage and surveillance station in one.

• cameraAudioDevice - AXIS audio device, used to transmit audio messages to and from a camera. The main device.

• 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 plotItem to store data from POS system.

• dashboard - Display several cameras or charts on one screen.

• device input - Device electric input. Example: Electric input events

• removedNode - A shell containing a removed node. Sometimes needed to preserve access to some of the nodes data.

• videoChannel - VAPIX video - IO (doors are open/closed, cash drawer open/closed, …)

• video channel - Video channel of a multichannel or panoramic camera. Example: Live It works in a similar way as camera. You can fetch live view and recordings

• panel -

• location - in case you have many localities is good can define .

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

1. Get aggregated metrics from multiple objects.

2. Manage user permissions for a group of objects.

3. Organizing objects into groups for better clarity in the user interface.
   

Examples with

...

objects:

List of all elements

...

Query:

query {
  nodeList {
      parent_node_id
      node_id
      type
      name
  }
}

Response:

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

query {
  nodeList(type:camera) {
    parent_node_id
    type
    name
    node_id
  }
}

Response:

...

...

and type

Anchor
Objects Objects

\uD83D\uDCCB Related articles