Получить список заданий на перевод

Находите задания по движку, статусу, триггеру или служебному ключу и переходите по страницам с помощью курсора.

Получите список заданий организации, доступных вызывающей стороне:

http
GET /v2/organizations/:orgId/localization/jobs?limit=50
X-API-Key: YOUR_API_KEY

Ответ содержит data — массив сводок по заданиям — и meta.nextCursor. Переходите по страницам с помощью nextCursor, пока его значение не станет null. Даже если страница пуста, курсор всё равно нужно проверить.

Фильтры #

ПараметрОписание
engineIdsИД движков, задания которых нужно включить в список.
statusesPending, Running, Completed, Failed или Cancelled.
triggersapi, cli, ci, github, payload или zendesk.
apiKeyIdsИД служебных ключей. Задания, созданные с личным ключом, привязаны к пользователю.
limitЦелое число от 1 до 100. По умолчанию — 50.
cursorНепрозрачный курсор из предыдущего ответа.

Чтобы передать несколько значений, повторите параметр массива, например statuses=Running&statuses=Failed. Не меняйте фильтры при переходе по страницам с помощью курсора. Задания возвращаются от новых к старым. Если время создания совпадает, порядок определяется ИД задания.

Поля сводки #

Каждая сводка содержит id, organizationId, engineId, sourceLocale, trigger, status, createdAt, updatedAt и createdBy. Статус — это объект с меткой типа, например { "_tag": "Running" }. Статус сбоя также содержит message.

Сводки не содержат документов и выходных файлов. Получите задание по id, чтобы узнать ключи документов, целевые локали, ход выполнения этапов и URL для скачивания.

По возможности сохраняйте в своём приложении ИД из ответа на запрос создания задания. Список заданий полезен для поиска причин проблем и восстановления, но версию исходных данных, на основе которой создано задание, нужно хранить в записях вашего приложения.