Дашборды (Boards)
Ресурс Boards — дашборд с графиками.

Получить дашборды

Запрос
Ответ
1
URL: {domain}/api/v1/boards{?catalogId}{?viewId}
Copied!
Метод: GET
Параметры:
  • catalogId (number, опционально) — идентификатор каталога
  • viewId (number, опционально) — идентификатор вида
Ответ: 200 OK (application/json)
1
[{
2
"id": "5",
3
"name": null,
4
"catalogId": "64",
5
"viewId": null
6
}, {
7
"id": "6",
8
"name": null,
9
"catalogId": "64",
10
"viewId": null
11
}, {
12
"id": "8",
13
"name": null,
14
"catalogId": "64",
15
"viewId": "142"
16
}, {
17
"id": "9",
18
"name": null,
19
"catalogId": "64",
20
"viewId": "137"
21
}, {
22
"id": "7",
23
"name": null,
24
"catalogId": "64",
25
"viewId": "140"
26
}]
Copied!

Получить дашборд

Запрос
Ответ
1
URL: {domain}/api/v1/boards/{boardsId}
Copied!
Метод: GET
Параметры:
  • boardsId (number) — идентификатор дашборда
Ответ: 200 OK (application/json)
1
[{
2
"id": "6",
3
"name": null,
4
"catalogId": "64",
5
"viewId": null,
6
"layouts": {
7
"xs": { // параметры отображения графика на широком экране
8
"14": { // идентификатор графика
9
"x": 0,
10
"y": 0,
11
"w": 2,
12
"h": 10
13
}
14
},
15
"xxs": { // параметры отображения графика на узком экране
16
"14": {
17
"x": 0,
18
"y": 0,
19
"w": 1,
20
"h": 4
21
}
22
}
23
}
24
}]
Copied!

Создать дашборд

Запрос
Ответ
1
URL: {domain}/api/v1/boards
Copied!
Метод: POST
Пример запроса: (application/json)
1
{
2
"catalogId": "64"
3
}
Copied!
Ответ: 200 OK (application/json)
1
{
2
"id": "6" // идентификатор созданного дашборда
3
}
Copied!

Удалить дашборд

Запрос
Ответ
1
URL: {domain}/api/v1/boards/{boardsId}
Copied!
Метод: DELETE
Параметры:
  • boardsId (number) — идентификатор дашборда
Ответ: 200 OK (application/json)
Last modified 1yr ago