Публичный Web API: Успешный ответ (Получение схемы виджета по коду и пространству имён)

Методы

GET — Получение схемы виджета по коду и пространству имён.

Ресурс

{
    "error": "string",
    "success": "boolean",
    "widget": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "dataCode": "string",
        "dataNamespace": "string",
        "descriptor": {
            "fields": [
                {
                    "array": "boolean",
                    "calcByFormula": "boolean",
                    "code": "string",
                    "data": "json",
                    "defaultValue": {},
                    "deleted": "boolean",
                    "formula": "string",
                    "indexed": "boolean",
                    "required": "boolean",
                    "searchable": "boolean",
                    "single": "boolean",
                    "type": "string",
                    "view": {
                        "data": {},
                        "name": "string"
                    }
                }
            ]
        },
        "name": "string",
        "namespace": "string"
    }
}

Свойства

Имя	Тип	Описание	Дополнительно
error	string	Текст ошибки, если `success == false`.	Опциональное
success	boolean	Признак успешного запроса.	Опциональное
widget	object	Полная схема виджета.	Опциональное
widget.__createdAt	date-time	Дата создания.	Опциональное
widget.__createdBy	uuid	Кем создано.	Опциональное
widget.__deletedAt	date-time	Дата удаления.	Опциональное
widget.__updatedAt	date-time	Дата редактирования.	Опциональное
widget.__updatedBy	uuid	Кем отредактировано.	Опциональное
widget.code	string	Код.	Опциональное
widget.dataCode	string	Код источника данных для виджета.	Опциональное
widget.dataNamespace	string	Пространство имён источника данных для виджета.	Опциональное
widget.descriptor	object	Шаблон виджета.	Опциональное
widget.descriptor.fields[]	array	Поля виджета.	Опциональное
widget.descriptor.fields[].array	boolean	Признак массива.	Опциональное
widget.descriptor.fields[].calcByFormula	boolean	Заполнение по формуле.	Опциональное
widget.descriptor.fields[].code	string	Код.	Опциональное
widget.descriptor.fields[].data	json	Дополнительные атрибуты поля.	Опциональное
widget.descriptor.fields[].defaultValue	object	Значение по умолчанию.	Опциональное
widget.descriptor.fields[].deleted	boolean	Признак удаления.	Опциональное
widget.descriptor.fields[].formula	string	Формула.	Опциональное
widget.descriptor.fields[].indexed	boolean	Быстрый поиск.	Опциональное
widget.descriptor.fields[].required	boolean	Обязательно для заполнения.	Опциональное
widget.descriptor.fields[].searchable	boolean	Поиск и сортировка по полю.	Опциональное
widget.descriptor.fields[].single	boolean	Признак количества значений, содержащихся в поле: `true` — одно значение, `false` — множество значений.	Опциональное
widget.descriptor.fields[].type	string	Тип. TYPE_UNSPECIFIED: Не задан. STRING: Cтрока. FLOAT: Число с плавающей точкой. INTEGER: Целое число. BOOLEAN: Выбор «да/нет». DATETIME: Дата и время. CATEGORY: Категория. MONEY: Деньги. FILE: Файл. PHONE: Телефон. EMAIL: Электронная почта. IMAGE: Изображение. STATUS: Статус. JSON: Произвольный тип (JSON). SYS_USER: Пользователь. FULL_NAME: Полное имя. LINK: Ссылка. SYS_COLLECTION: Ссылка на элемент определённого приложения. REF_ITEM: Ссылка на элемент произвольного приложения. ENUM: Перечисление. TABLE: Таблица. ACCOUNT: Учётная запись. ROLE: Роль. REPORT: Отчёт. UUID: UUID. EVENT: Событие. COLLECTION_TYPE: Ссылка на тип приложения. SYS_DIRECTORY: Ссылка на папку. Возможные значения: `TYPE_UNSPECIFIED` `STRING` `FLOAT` `INTEGER` `BOOLEAN` `DATETIME` `CATEGORY` `MONEY` `FILE` `PHONE` `EMAIL` `IMAGE` `STATUS` `JSON` `SYS_USER` `FULL_NAME` `LINK` `SYS_COLLECTION` `REF_ITEM` `ENUM` `TABLE` `ACCOUNT` `ROLE` `REPORT` `UUID` `EVENT` `COLLECTION_TYPE` `SYS_DIRECTORY`	Опциональное
widget.descriptor.fields[].view	object	Краткое описание данных для отображения поля приложения.	Опциональное
widget.descriptor.fields[].view.data	object	Параметры отображения, специфичные для определённого типа поля.	Опциональное
widget.descriptor.fields[].view.name	string	Название.	Опциональное
widget.name	string	Название виджета.	Опциональное
widget.namespace	string	Пространство имён.	Опциональное