Справочник API

Выгрузки

Выгрузка дел и доказательств с перечнем дайджестов.

Список выгрузок

GET/v1/exports

Области доступа
exports:read

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет

Ответы

  • 200ExportList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Создать выгрузку

POST/v1/exports

Области доступа
exports:write
Обязательный заголовок
Idempotency-Key

Тело запросаExportCreate

ПолеТипОбязательно
fromstring (date-time)да
tostring (date-time)да
resource_typesarray of enum: cases, reports, audit, usageда
purposestringда
include_mediabooleanда

Ответы

  • 202Export
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Получить выгрузку

GET/v1/exports/{export_id}

Области доступа
exports:read

Параметры

ПолеТипОбязательно
export_idпутьstring (uuid)да

Ответы

  • 200Export
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Скачать выгрузку

POST/v1/exports/{export_id}/download

Области доступа
exports:download
Обязательный заголовок
Idempotency-Key

Параметры

ПолеТипОбязательно
export_idпутьstring (uuid)да

Ответы

  • 200Download
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get tenant overview

GET/v1/overview

Области доступа
cases:read

Overview of the customer for the period: case counts by state, submissions, decisions and decision latency, state of the sources. No personal data.

Параметры

ПолеТипОбязательно
fromзапросPeriod start (default: 30 days before to).string (date-time)нет
toзапросPeriod end (default: now); the period is at most 366 days.string (date-time)нет

Ответы

  • 200TenantOverview
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

List request logs

GET/v1/request-logs

Области доступа
logs:read

Sanitized API key requests of the customer for the retention period, newest first.

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет
outcomeзапросenum: success, client_error, server_errorнет
operation_idзапросstringнет

Ответы

  • 200RequestLogList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503