Page History

...

Hereinafter, any system object or element will be called a unit.

Input data

1. added − – an array of units that should be added;.
2. changed −  – an array of units that should be changed;.
3. remove − – an array of units that units that should be removed.

Unit structure

...

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:

1. failed − – the units that could not be added.
2. added − – the uid of the successfully added unit.

...

1. units is a list of successfully found units;.
2. unreachable_objects is a list of temporarily unavailable units;.
3. not_found_objects is a list of not found units.

...

1. 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.
2. 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).
3. type is a unit type. For example, for a DeviceIpint.1 unit, the field type == DeviceIpint.
4. properties is a list of unit settings.
5. 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.
6. factory are included units that can be created for a given unit. The available fields are:
   1. type − – a type of subunit that can be created;
   2. properties − – a list of subunit properties.