Список ранее сформированных отчётов

POST /v1/report/list

POST/v1/report/list

Тело запроса

filter

object

Параметры фильтрации.

Показать свойства

report_type

array

Фильтр по типам.

Тип отчёта.

status

array

Фильтр по статусам.

Статус формирования отчёта.

created_since

string

Нижняя граница создания (RFC3339).

created_to

string

Верхняя граница создания (RFC3339).

cursor

string

Курсор постраничной выборки.

limit

integer

Размер страницы. min = 1; max = 300; default = 100.

Успешный ответ

200A successful response.

application/json

object

reports

array

Список отчётов.

reportFboListItem

Показать свойства

reportFboListItem

report_id

string

Идентификатор отчёта.

status

string

Статус формирования.

Допустимые значения

PENDINGPROCESSINGSUCCESSFAILED

file

object

Файл отчёта.

Показать свойства

file_id

string

Идентификатор файла.

name

string

Имя файла.

url

string

Ссылка для скачивания.

expires_at

string

Время истечения ссылки (RFC3339).

next_cursor

string

Курсор следующей страницы.

Ошибки

400Некорректный запрос

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

401Ошибка авторизации

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

429Превышен лимит запросов

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

500Внутренняя ошибка сервера

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

defaultОшибка (неожиданная или прочие)

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

Код ошибки. OPERATION_NOT_SUPPORTED — операция недоступна для текущей конфигурации.

Допустимые значения

OPERATION_NOT_SUPPORTED

message

string

сообщение

details

object

POST/v1/report/list

1curl https://api.omninet.ru/v1/report/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "report_type": [7      "string"8    ],9    "status": [10      "string"11    ],12    "created_since": "string",13    "created_to": "string"14  },15  "cursor": "string",16  "limit": 017}'

{
  "reports": [
    {
      "report_id": "string",
      "status": "string",
      "file": {
        "file_id": "string",
        "name": "string",
        "url": "string",
        "expires_at": "string"
      }
    }
  ],
  "next_cursor": "string"
}

A successful response.