Record of change of object (changes)

Description

Any change to some objects (entity types) is recorded in the change log. Each log item represents one specific operation performed on a specific object.

The following are considered changes: creating a new object (create), changing the values of fields of an existing object (update), deleting an existing object (delete).
The change history log of each line about the creation contains a complete JSON representation at the time of creation. Each line about the change contains the full JSON representation of the object after the corresponding change, as well as a list of the fields that have undergone the change. Each line about the deletion contains the value of the identifier field.

Limitations

  • A change record cannot be created or deleted directly. Their totality is only a reflection of the stored history.

  • Only entities managed by the domain center (reflected in the specification entities).

Fields

Entity structure
{
  "cmdtype": uuid,
  "dtutc": date,
  "fields": str,
  "modifierid": uuid,
  "modifiername": str,
  "obj": object,
  "objid": uuid,
  "objtype": str
}
Table 1. Fields
Specification Description

Field: cmdtype
Mode: out
Type: str

Operation Type.
Possible values:

  • "update" – The values of the existing facility have been changed.

  • "create" – A new object has been created.

  • "delete" – A pre-existing object has been deleted.

Field: dtutc
Mode: out
Type: date

Date/time in UTC of the transaction in the format of RFC3339.
For example, "2019-08-21T13:59:39.833Z".

Field: fields
Mode: out
Type: str

List of object fields that have been modified.
Just for cmdtype = update.
For example, "enabled,ext.lwt,lwt,opts.comment".

Field: modifierid
Mode: out
Type: uuid

Identifier of the user account on behalf of which the transaction was performed.

Field: modifiername
Mode: out
Type: str

The name of the user account on whose behalf the transaction was performed.

Field: obj
Mode: out
Type: object

The full content of the object as a JSON structure.
For operations of creating and changing field values - after the operation is performed.
For removal surgery, immediately prior to removal.

Field: objid
Mode: out
Type: uuid

Object Identifier

Field: objtype
Mode: out
Type: str

Entity Type.
For example, "provider".

See also

Logical roles

  • mdc and sdc perform entity management and save data to the change log.