Группировка рабочих столов
Запрос
Тип | Метод |
---|---|
POST |
/dashboards/group |
Описание: При выполнении запроса рабочие столы будут сгруппированы по заданному полю. Особенности выполнения запроса:
- Рабочие столы, созданные автоматически при создании отчета (“is_report” = true (в базе данных)), не учитываются в ответе.
- В ответе учитываются только те рабочие столы, владельцем которых является пользователь, чей ID передан в заголовке “Pgr-User-ID”.
- Для пользователя с ролью “admin” учитываются все рабочие столы, где “is_report” = false, независимо от прав просмотра, указанных владельцем.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/dashboards/group
Тело запроса:
Параметр | Тип данных | Обязательность | Описание |
---|---|---|---|
group_field | string |
Required | Поле для группировки объектов |
Пример тела запроса
{
"group_field": "string"
}
Успешный ответ
Статус код: 200
- успешный ответ.
Формат: JSON
.
Параметры ответа
Параметр | Тип данных | Описание |
---|---|---|
tems | Array |
Список объектов сгруппированных по полю |
items{value} | string |
Значение поля |
items{count} | integer |
Количество повторений |
Пример ответа
{
"items": [
{
"value": "string",
"count": 1
}
]
}
Другие возможные ответы
Код | Ответ | Описание |
---|---|---|
400 |
Bad Request missing uid header |
Неверный тип параметра запроса, либо отсутствует обязательный параметр Не передан заголовок “Pgr-User-ID” |
500 |
Internal Server Error |
Ошибка маппинга поля группировки с моделью группируемых объектов, другие ошибки сервера |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{ "error": "Bad Request", "error_code": 400 }
Код 500
{ "error": "Internal Server Error", "error_code": 500 }