Обзор :: Справочная документация

Параметры полей сущности

Режим

Все перечисляемые поля доступны для чтения. Режим работы поля определяет его применение системой:

out - поле изменяется системой для информирования, изменения пользователем не допускаются или не влияют на поведение системы.
in - поле изменяется пользователем с целью изменения поведения системы или сохранения данных в привязке к объекту.
inout - поле изменяется и системой, и пользователем, соответственно отражая состояние и влияя на поведение системы.

Тип

Возможные типы значений:

Тип Описание Примеры — Пустое значение

Тип	Описание	Примеры — Пустое значение
`uuid`	Идентификатор	`"00000000-0000-0000-0000-000000000000`
`str`	Строка	`"Значение" — ""`
`int`	Целое число	`125 — 0`
`float`	Дробное число	`2.83 — 0.0`
`date`	Дата в RFC3339	`"2019-09-06T09:12:00Z"`
`object`	JSON-объект	`{"key":"abcdef", "order":125} — {}`
`array<str>`	JSON-массив из типов str	`["abc", "def", "xxx"] — []`
`array<int>`	JSON-массив из типов int	`[5, 10, -3] — []`
`array<object>`	JSON-массив из типов object	`[{"k":"abc"}, {"k":"def"}] — []`
`array<T>`	JSON-массив из типов <T>	`[<T>, <T>] — []`
`json`	JSON-значение (объект, массив, строка в кавычках, число, null)	`"\"abc\"", {"a":123}" — {}`
`any`	Любое значение	`"abc", {"a":123} — ""`

uuid

Идентификатор

"00000000-0000-0000-0000-000000000000

str

Строка

"Значение" — ""

int

Целое число

125 — 0

float

Дробное число

2.83 — 0.0

date

Дата в RFC3339

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

object

JSON-объект

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

array<str>

JSON-массив из типов str

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

array<int>

JSON-массив из типов int

[5, 10, -3] — []

array<object>

JSON-массив из типов object

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

array<T>

JSON-массив из типов <T>

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

json

JSON-значение (объект, массив, строка в кавычках, число, null)

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

any

Любое значение

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

Умолчание

Значения по умолчанию:

required – поле является обязательным для указания при создании ресурса.
generated – генерируется системой при создании ресурса; в некоторых случаях может быть указан при создании, тогда применяется указанное значение.
empty – пустое значение соответствующего типа.
str_empty – пустая строка.

Entities

Entity (сущность) – это объект одноименного класса, определяющий связанный с этим классом аспект работы системы. Объект доступен для просмотра/изменения через API, посредством чего осуществляется управление системой.

Характерной отличительной особенностью сущностей является наличие идентификаторов, однозначно отделяющих один объект от другого объекта того же класса.

Вся совокупность классов сущностей образует дерево, структура и последовательность разделов эквивалентна дереву разделов REST-API и явяется его подмножеством.

Разделы

Сущности