Overview

Entity field parameters

Type

Possible value types:

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} — ""

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.

Sections

Categories

Configuration structure - the value of the "content" field of the entity configurations.

Configuration categories are the root elements of the configuration structure.

Configuration can be generated immediately as a JSON-structure, or you can use the "Configuration Editor" application".

The articles listed below provide a description of the categories and examples of their values in a JSON structure.