Overview :: Documentation

Entity field parameters

Mode

All enumerated fields are readable. The mode of operation of a field determines its application by the system:

out - field is changed by the system to inform, user changes are not allowed or do not affect the behavior of the system.
in - field is changed by the user to modify the system behavior or to save data bound to an object.
inout - field is modified by both the system and the user, respectively reflecting the state and influencing the behavior of the system.

Type

Possible value types:

Type Description Examples — Empty value

Type	Description	Examples — Empty value
`uuid`	Identifier	`"00000000-0000-0000-0000-000000000000`
`str`	String	`"Significance" — ""`
`int`	Integer	`125 — 0`
`float`	fractional number	`2.83 — 0.0`
`date`	Date in RFC3339	`"2019-09-06T09:12:00Z"`
`object`	JSON-object	`{"key":"abcdef", "order":125} — {}`
`array<str>`	JSON-type array str	`["abc", "def", "xxx"] — []`
`array<int>`	JSON-type array int	`[5, 10, -3] — []`
`array<object>`	JSON-type array object	`[{"k":"abc"}, {"k":"def"}] — []`
`array<T>`	JSON-type array <T>	`[<T>, <T>] — []`
`json`	JSON-value (object, array, quoted string, number, null)	`"\"abc\"", {"a":123}" — {}`
`any`	Any value	`"abc", {"a":123} — ""`

uuid

Identifier

"00000000-0000-0000-0000-000000000000

str

String

"Significance" — ""

int

Integer

125 — 0

float

fractional number

2.83 — 0.0

date

Date in RFC3339

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

object

JSON-object

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

array<str>

JSON-type array str

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

array<int>

JSON-type array int

[5, 10, -3] — []

array<object>

JSON-type array object

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

array<T>

JSON-type array <T>

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

json

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

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

any

Any value

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

Mention

Default values:

required – field is mandatory to be specified when creating a resource.
generated – is generated by the system when the resource is created; in some cases it may be specified at creation, then the specified value is applied.
empty – empty value of the corresponding type.
str_empty – blank line.

Entities

Entity (entity) is an object of the class of the same name that defines an aspect of the system associated with this class. The object is available for viewing/modifying via API, through which the system is managed.

A characteristic feature of entities is the presence of identifiers that uniquely separate one entity from another entity of the same class.

The entire set of entity classes forms a tree, the structure and sequence of the partitions is equivalent to and is a subset of the REST-API partition tree.

Sections

Entities