Overview

Entity field parameters

Mode

All listed fields are readable. The field mode determines how the system uses it:

  • out - the field is changed by the system for information; user changes are not allowed or do not affect system behavior.

  • in - the field is changed by the user to modify system behavior or to store data bound to the object.

  • inout - the field is changed by both the system and the user, reflecting state and affecting system behavior.

Type

Possible value types:

Type Description Examples — Empty value

uuid

Identifier

"00000000-0000-0000-0000-000000000000

str

String

"Value" — ""

int

Integer

125 — 0

float

Float

2.83 — 0.0

date

Date in RFC3339

"2019-09-06T09:12:00Z"

object

JSON object

{"key":"abcdef", "order":125} — {}

array<str>

JSON array of str types

["abc", "def", "xxx"] — []

array<int>

JSON array of int types

[5, 10, -3] — []

array<object>

JSON array of object types

[{"k":"abc"}, {"k":"def"}] — []

array<T>

JSON array of <T> types

[<T>, <T>] — []

json

JSON value (object, array, quoted string, number, null)

"\"abc\"", {"a":123}"  — {}

any

Any value

"abc", {"a":123} — ""

Default

Default values:

  • required – the field is required when creating a resource.

  • generated – generated by the system when creating a resource; in some cases it can be specified at creation, in which case the specified value is used.

  • empty – the empty value of the corresponding type.

  • str_empty – an empty string.

Entities

An entity is an object of the class of the same name that defines the aspect of system operation associated with that class. The object is available for viewing/modification through the API, through which the system is managed.

A characteristic distinguishing feature of entities is the presence of identifiers that unambiguously separate one object from another object of the same class.

The entire set of entity classes forms a tree; the structure and sequence of sections are equivalent to the tree of REST API sections and are a subset of it.