unit groups
Depending on the specified flags, the response format may vary.
This chapter describes the flags that can be applied to unit groups and the corresponding parts of the resulting JSON they control. If multiple flags are specified, their respective parts are combined into a single JSON.
All flags are used only in DEC format.
Unit group flags
The following flags can be applied to unit groups:
HEX value | DEC value | Description |
|---|---|---|
| 0x00000001 | 1 | General properties (base flag) |
| 0x00000002 | 2 | Custom properties |
| 0x00000004 | 4 | Billing information |
| 0x00000008 | 8 | Custom fields |
| 0x00000010 | 16 | Image |
| 0x00000040 | 64 | GUID |
| 0x00000080 | 128 | Administrative fields |
0x3FFFFFFFFFFFFFFF | 4611686018427387903 | Set all unit group flags |
General properties
The flag of general properties is 0x00000001.
{
"nm": <text>, /* Name */
"cls": <uint>, /* Superclass ID: avl_unit_group */
"id": <uint>, /* Group ID */
"u": [<long>], /* Array of group units */
"uacl": <uint> /* User's access rights to the unit group */
}
Custom properties
The flag of custom properties is 0x00000002.
You can store any data in custom properties.
{
"prp": {} /* Custom properties */
}
Billing information
The flag of billing information is 0x00000004.
{
"crt": <uint>, /* Creator ID */
"bact": <uint> /* Account ID */
}
Custom fields
The flag of custom fields is 0x00000008.
{
"flds": { /* Custom fields */
<text>: { /* Sequence number */
"id": <uint>, /* ID */
"n": <text>, /* Name */
"v": <text> /* Value */
},
...
},
"fldsmax": <long> /* Maximum number of custom fields (-1 for unlimited) */
}
Unit group image
The flag of the unit group image is 0x00000010.
{
"ugi": <uint> /* Number of image changes */
}
GUID
The flag of GUID is 0x00000040.
{
"gd": <text> /* group GUID */
}
Administrative fields
The flag of administrative fields is 0x00000080.
{
"aflds": { /* Administrative fields */
<text>: { /* Sequence number */
"id": <uint>, /* ID */
"n": <text>, /* Name */
"v": <text> /* Value */
},
...
},
"afldsmax": <long>, /* Maximum number of administrative fields (-1 for unlimited) */