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

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

Методы

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

Ресурс

{
    "error": "string",
    "report": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "columns": [
            {
                "code": "string",
                "name": "string",
                "type": "string"
            }
        ],
        "name": "string",
        "namespace": "string"
    },
    "success": "boolean"
}

Свойства

Имя Тип Описание Дополнительно
error string

Текст ошибки, если success == false.

 Опциональное
report object

Полная схема отчёта.

 Опциональное
report.__createdAt date-time

Дата создания.

 Опциональное
report.__createdBy uuid

Кем создан.

 Опциональное
report.__deletedAt date-time

Дата удаления.

 Опциональное
report.__updatedAt date-time

Дата редактирования.

 Опциональное
report.__updatedBy uuid

Кем отредактирован.

 Опциональное
report.code string

Код.

 Опциональное
report.columns[] array

Колонки отчёта.

 Опциональное
report.columns[].code string

Код.

 Опциональное
report.columns[].name string

Название.

 Опциональное
report.columns[].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
 Опциональное
report.name string

Название отчёта.

 Опциональное
report.namespace string

Раздел.

 Опциональное
success boolean

Признак успешного запроса.

 Опциональное