Получение списка элементов отчёта
Запрос
POST /pub/v1/reports/{namespace}/{code}/list
Параметры пути (path)
Имя параметра | Тип | Описание | Дополнительно |
---|---|---|---|
namespace | string | Код раздела |
Обязательный |
code | string | Код отчёта |
Обязательный |
Тело запроса (body)
Тело запроса принимает ресурс Получение списка элементов отчёта — Request. Содержит следующие доступные для записи свойства:
{
"filter": {
"<key>": {}
},
"from": "uint32",
"size": "uint32",
"sortExpressions": [
{
"ascend": "boolean",
"column": "string"
}
]
}
Свойства
Имя | Тип | Описание | Дополнительно |
---|---|---|---|
filter | object |
Фильтрация (только «Табличная операция») |
Опциональное |
filter.<key> | map of object | Опциональное | |
from | uint32 |
Возвращать начиная с элемента |
Опциональное |
size | uint32 |
Количество возвращаемых элементов (максимум 10000) |
Опциональное |
sortExpressions[] | array |
Правила сортировки |
Опциональное |
sortExpressions[].ascend | boolean |
Признак сортировки по возрастанию |
Опциональное |
sortExpressions[].column | string |
Колонка сортировки |
Опциональное |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации:
API key
Ответ
Могут быть возвращены следующие коды состояния HTTP:
HTTP-статус | Описание | Модель ответа |
---|---|---|
200 | OK Модель списка элементов отчёта |
Модель списка элементов отчёта (Получение списка элементов отчёта) |