Contact group (contactgroup)

Description

A group of address book contacts. Associates with address book contacts.
It is used in applications and services that regularly communicate with the same set of subscribers: conference calls, alerts, etc.
Can synchronize with LDAP in scheduled scenarios.

Limitations

  • The collection is available in working domains

Fields

Entity structure
{
  "id": uuid,
  "code": str,
  "name": str,
  "shortname": str,
  "opts": {
    "title": str,
    "comment": str,
    "priority": int,
    "abonents": array<int>,
    "abonentcount": int
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}
Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: code
Mode: in
Type: str
Default: generated

Unique group code. Used to link to the group. If not specified at creation, it is automatically generated as uuid. Used for association with other entities.

Field: name
Mode: in
Type: str
Default: required

Full name

Field: shortname
Mode: in
Type: str
Default: empty

Short name

Field: opts
Mode: inout
Type: object
Composite field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary header

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: opts.priority
Mode: in
Type: int
Default: 1000

Group priority applied when building the list for notification. Synchronized with contact priorities.

Field: opts.abonents
Mode: inout
Type: array<int>
Default: empty

A list of contacts (autokey field) belonging to the group. It is automatically linked to a similar contact field and can be changed by the system.

Field: opts.abonentcount
Mode: out
Type: int
Default: generated

Number of subscribers in the group. Automatically filled in when the number of subscribers in the group changes.

Field: ext
Mode: inout
Type: object
Compound field

Allows you to extend the compound with arbitrary keys and values

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object