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 |
|---|---|---|
|
Identifier |
|
|
String |
|
|
Integer |
|
|
Float |
|
|
Date in RFC3339 |
|
|
JSON object |
|
|
JSON array of str types |
|
|
JSON array of int types |
|
|
JSON array of object types |
|
|
JSON array of <T> types |
|
|
JSON value (object, array, quoted string, number, null) |
|
|
Any value |
|
- 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.