Public Web API: Successful response (Get the widget metadata description by code and namespace)

Methods

GET — Get the widget metadata description by code and namespace.

Resource

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

Properties

Name	Type	Description	Additional
error	string	Текст ошибки, если `success == false`.	Optional
success	boolean	Признак успешного запроса.	Optional
widget	object	Полная схема виджета.	Optional
widget.__createdAt	date-time	Дата создания.	Optional
widget.__createdBy	uuid	Кем создано.	Optional
widget.__deletedAt	date-time	Дата удаления.	Optional
widget.__updatedAt	date-time	Дата редактирования.	Optional
widget.__updatedBy	uuid	Кем отредактировано.	Optional
widget.code	string	Код.	Optional
widget.dataCode	string	Код источника данных для виджета.	Optional
widget.dataNamespace	string	Пространство имён источника данных для виджета.	Optional
widget.descriptor	object	Шаблон виджета.	Optional
widget.descriptor.fields[]	array	Поля виджета.	Optional
widget.descriptor.fields[].array	boolean	Признак массива.	Optional
widget.descriptor.fields[].calcByFormula	boolean	Заполнение по формуле.	Optional
widget.descriptor.fields[].code	string	Код.	Optional
widget.descriptor.fields[].data	json	Дополнительные атрибуты поля.	Optional
widget.descriptor.fields[].defaultValue	object	Значение по умолчанию.	Optional
widget.descriptor.fields[].deleted	boolean	Признак удаления.	Optional
widget.descriptor.fields[].formula	string	Формула.	Optional
widget.descriptor.fields[].indexed	boolean	Быстрый поиск.	Optional
widget.descriptor.fields[].required	boolean	Обязательно для заполнения.	Optional
widget.descriptor.fields[].searchable	boolean	Поиск и сортировка по полю.	Optional
widget.descriptor.fields[].single	boolean	Признак количества значений, содержащихся в поле: `true` — одно значение, `false` — множество значений.	Optional
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: Ссылка на папку. Possible values are: `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`	Optional
widget.descriptor.fields[].view	object	Краткое описание данных для отображения поля приложения.	Optional
widget.descriptor.fields[].view.data	object	Параметры отображения, специфичные для определённого типа поля.	Optional
widget.descriptor.fields[].view.name	string	Название.	Optional
widget.name	string	Название виджета.	Optional
widget.namespace	string	Пространство имён.	Optional