Contact group (contactgroup)

Description

Address book contact group. Associated with address book contacts.
Used in applications and services that regularly communicate with the same set of subscribers: selective meetings, alerts, etc.
Can be synchronized with LDAP in scheduled scripts.

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 reference the group. If not specified at creation, it is generated automatically as a uuid. Used to associate 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
Compound field

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

Arbitrary title

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

Arbitrary comment

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

Group priority used when building the alert list. Synchronized with contact priorities.

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

List of contacts (the autokey field) belonging to the group. Automatically linked with the corresponding 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 when the group’s subscriber composition changes.

Field: ext
Mode: inout
Type: object
Compound field

Allows extending 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