Go to documentation repository
Page History
...
Tip |
---|
Manage devices using gRPC API methods (ConfigurationService) |
Axxon Next configuration settings are described in the ConfigurationService.proto proto file.
There are 2 methods used:
- Changeconfig.
- ListConfig.
ChangeConfig method
The ChangeConfig method allows to create, edit and delete any system objects.
Hereinafter, any system object or element will be called a unit.
Input data
- added - – an array of units that should be added.
- changed - – an array of units that units that should be changed.
- remove - – an array of units that should be removed.
...
A unit can contain subunits (the units field). For example, a VideoChannel.0 unit may have a child unit Streaming.0.
Each unit has a uid field - – it is a unit identifier, which consists of all the "parents" of the unit, separated by the "/" symbol. For example, the uid field of the Streaming.0 unit will be as follows: hosts/Node1/DeviceIpint.1/VideoChannel.0/Streaming.0.
...
In response to the method, the following data will be received:
- failed - – the units that could not be added.
- added - – the uid of the successfully added unit.
...
The units field is of UnitDescriptor type.
Data parameters:
- uid is a unit identifier, which consists of all the "parents" of the unit, separated by the "/" symbol. For example, the uid field of the Streaming.0 unit will be as follows: hosts/Node1/DeviceIpint.1/VideoChannel.0/Streaming.0.
- display_id is a short id, which is usually unique in a parent scope. For example, for a DeviceIpint.1 unit, the field display_id == 1 (sometimes type can go together with it).
- type is a unit type. For example, for a DeviceIpint.1 unit, the field type == DeviceIpint.
- properties is a list of unit settings.
- units are included units that can have either a full description or a short one. In this case, the field stripped == true, and the only fields that are available from the description are: display_id, type, uid.
- factory are included units that can be created for a given unit. The available fields are:
- type
...
- – a type of subunit that can be created
...
- ;
- properties
...
- – a list of subunit properties.