Сайт
Поддержка
Search…
Бипиум
🎂
Версии и обновления
Документация
🏗
Конструктор данных
📊
Отчеты
🔑
Права
🤖
Автоматизации
Примеры
🔑
Права доступ к данным
🤖
Автоматизации
Интеграции
🥂
Методы интеграции
🔌
API
Данные
Агрегация
Отчеты
Дашборды (Boards)
Графики (Widgets)
Поисковые выборки
Права (Rights)
Профиль (Profile/me)
Установка на сервер
🧱
Архитектура
🖥
Требования
📂
Установка как служба
🛳
Установка через Docker
🆘
Материалы
Powered By
GitBook
Дашборды (Boards)
Ресурс Boards — дашборд с графиками.
Получить дашборды
Запрос
Ответ
URL: {domain}/api/v1/boards{?catalogId}{?viewId}
Метод:
GET
Параметры:
catalogId
(number, опционально) — идентификатор каталога
viewId
(number, опционально) — идентификатор вида
Ответ: 200 OK (application/json)
[{
"id"
:
"5"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
null
},
{
"id"
:
"6"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
null
},
{
"id"
:
"8"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
"142"
},
{
"id"
:
"9"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
"137"
},
{
"id"
:
"7"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
"140"
}]
Получить дашборд
Запрос
Ответ
URL: {domain}/api/v1/boards/{boardsId}
Метод:
GET
Параметры:
boardsId
(number) — идентификатор дашборда
Ответ: 200 OK (application/json)
[{
"id"
:
"6"
,
"name"
:
null
,
"catalogId"
:
"64"
,
"viewId"
:
null
,
"layouts"
:
{
"xs"
:
{
// параметры отображения графика на широком экране
"14"
:
{
// идентификатор графика
"x"
:
0
,
"y"
:
0
,
"w"
:
2
,
"h"
:
10
}
},
"xxs"
:
{
// параметры отображения графика на узком экране
"14"
:
{
"x"
:
0
,
"y"
:
0
,
"w"
:
1
,
"h"
:
4
}
}
}
}]
Создать дашборд
Запрос
Ответ
URL: {domain}/api/v1/boards
Метод:
POST
Пример запроса: (application/json)
{
"catalogId"
:
"64"
}
Ответ: 200 OK (application/json)
{
"id"
:
"6"
// идентификатор созданного дашборда
}
Удалить дашборд
Запрос
Ответ
URL: {domain}/api/v1/boards/{boardsId}
Метод:
DELETE
Параметры:
boardsId
(number) — идентификатор дашборда
Ответ: 200 OK (application/json)
Previous
Отчеты
Next
Графики (Widgets)
Last modified
2yr ago
Copy link
Outline
Получить дашборды
Получить дашборд
Создать дашборд
Удалить дашборд