Ресурс Boards — дашборд с графиками

Дашборд

URL: /{api url}/boards/{boardsId}

Параметры:

  • boardsId: (number) — идентификатор дашборда

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

Ответ: 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
}
}
}
}
]

Удалить дашборд [DELETE]

Не реализовано

Коллекция дашбордов

Запрос: (application/json)

URL: /{api url}/boards{?catalogId}{?viewId}

Параметры:

  • catalogId: (number, опционально) — идентификатор каталога

  • viewId: (number, опционально) — идентификатор вида

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

Пример получения дашбордов на объект: catalogId=64 Ответ: 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"
}
]

Создать дашборд [POST]

Запрос: (application/json)

URL: /{api url}/boards
{
"catalogId": "64"
}

Ответ: 200 OK (application/json)

{
"id": "6" // идентификатор созданного дашборда
}