翻訳ジョブの一覧取得

エンジン、ステータス、トリガー、サービスキーでジョブを絞り込み、カーソルを使ってページを順に取得します。

組織内で呼び出し元が閲覧できるジョブを一覧取得します。

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サービスキーの識別子。個人キーで作成されたジョブは、そのユーザーに紐づけられます。
limit1から100までの整数。既定値は50です。
cursor前のレスポンスで返された、内部構造を解釈せずにそのまま使用するカーソル。

複数の値を指定する場合は、statuses=Running&statuses=Failedのように配列パラメーターを繰り返し指定します。カーソルをたどっている間は、フィルターを変更しないでください。ジョブは作成日時の新しい順に返され、作成時刻が同じ場合はジョブの識別子で順序が決まります。

概要のフィールド #

各概要には、id、organizationId、engineId、sourceLocale、trigger、status、createdAt、updatedAt、createdByが含まれます。ステータスは{ "_tag": "Running" }のようなタグ付きオブジェクトで、失敗を示す場合はmessageも含まれます。

概要にはドキュメントや出力ファイルは含まれません。ドキュメントキー、対象ロケール、各段階の進捗、ダウンロード先のアドレスを確認するには、idを指定してジョブを取得してください。

可能な限り、作成時のレスポンスに含まれる識別子を、ご自身のアプリケーションに保存してください。一覧取得は調査や復旧に役立ちますが、ジョブの生成元となったソースのリビジョンは、アプリケーション側で記録しておく必要があります。