Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
СправочникСправочник APIПакеты

Получить пакет

Доступ: ключ API со скоупом runs:read или сессия.

GET/v1/batches/{id}Песочница

Авторизация

Проверяем сессию Кабинета…

Параметры

обязательный
string
Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

Организация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.

Response Body

Пакет

application/json
  1. response
id*string
object*"batch"
Value in"batch"
typizer_id*string
status*string
Value in"processing""completed"
total*integer
succeeded*integer
failed*integer
created_at*string
Formatdate-time
completed_at*|
Formatdate-time
curl -X GET 'https://api.typizer.ru/v1/batches/string'
Example Response
{  "id": "string",  "object": "batch",  "typizer_id": "string",  "status": "processing",  "total": 0,  "succeeded": 0,  "failed": 0,  "created_at": "2019-08-24T14:15:22Z",  "completed_at": "2019-08-24T14:15:22Z"}

Скачать результаты пакета

Результаты успешных прогонов пакета, которые ещё хранятся, в порядке создания прогонов (Content-Disposition: attachment; filename="<batch id>.<ext>"). csv — одна таблица со столбцом run_id или zip из data.csv и отдельного файла на каждое поле-массив; xlsx — то же в виде листов; zip — по одному <run id>.json на прогон. В csv и xlsx текстовое значение, которое таблица могла бы выполнить как формулу, записывается с ведущим '. 409, пока пакет обрабатывается. Передаётся потоком по мере формирования (без Content-Length); сбой на середине обрывает передачу, а не завершает её раньше. xlsx отклоняется (413), если в таблице больше строк, чем вмещает лист. Не больше 2 выгрузок одновременно на организацию (429), 503, пока сервер занят; оба ответа с Retry-After. Доступ: ключ API со скоупом runs:read или сессия.

Список пакетов, новые первыми

Пагинация по курсору, новые первыми. Прогоны пакета: GET /v1/runs?batch_id=. Доступ: ключ API со скоупом runs:read или сессия.