HTTPステータスコードとレスポンス形式

サーバーは以下のHTTPステータスコードを返します：

• 200 – メソッドの呼び出し成功
• 4xx – メソッドの不正なパラメータ
• 5xx – サーバー側のエラー

レスポンスの本文にはJSONが含まれます。

ステータスコード200のレスポンス形式

{
  "taskId": <task guid>,
  "registrationTime": <task creation time>,
  "statusChangeTime": <status change time>,
  "status": <status>,
  "filesCount": <amount of submitted files>,
  "error": <error text>,
  "requestStatusDelay": <recommended delay before next gettaskstatus request in ms>,
  "resultUrls": [
    <url1>,
    <url2>
  ],
  "description": <description>
}

• resultUrls – この属性は最大3つのURLを提供する配列です。 T最初のURLが利用できるのは完了したタスクのみです。 これには処理結果が含まれます。

  結果をダウンロードするためのGETリクエストに、承認ヘッダーを含めてはなりません。 Cloud OCR SDK承認ヘッダーを使用すると、エラーを返します。

  2番目のURLは、複数のエクスポート形式で処理された、完了したタスクに使用できます。 2番目の指定形式で保存された結果が含まれます。

  3番目のURLは、3つのエクスポート形式で処理された、完了したタスクに使用できます。 3番目の指定形式で保存された結果が含まれます。

  ハイパーリンクには有効期限があります。 その有効期限以降に結果をダウンロードしたい場合は、getTaskStatusまたはlistTasksメソッドを使って、新しいハイパーリンクを取得してください。
• filesCount – タスク中のファイルの数を指定します。
• requestStatusDelay – タスクが完了するまでの予定時間（ミリ秒）。 この属性はQueuedまたはInProgressステータスのタスクで利用できます。
• error – 処理中に発生したエラーの説明。 この属性はProcessingFailedステータスのタスクのみ利用できます。

最初のタスクが失敗した場合、何度も繰り返し同じファイルを送信することはおすすめしません。 しかし、同じファイルに対して複数のタスクを作成し、そのすべてが失敗した場合、getTaskStatusを呼び出せば最初のタスクの詳細なエラー情報が取得できます。

ステータスコード4xxおよび5xxのレスポンス形式

{
 "error":
 {
    "code":<error internal name>,
    "message":<error message>,
    "target":<target argument>,
    "details":
    [
      {
        "code":<validation error internal name>,
        "target":<target argument>,
        "message":<error message>
      }
    ]
  }
}

• code – 発生したエラーの内部的な固有名。 下記の表は、可能性のあるエラー名です。
• message – 人間が理解できる形のエラーの説明。
• target – エラーの原因となったリクエストの引数。例：必須のtaskId引数が指定されていない場合、ターゲット要素は"taskId"という値を保存します。このパラメータは、オプションです。
• details – HTTPレスポンスステータスコード400の InvalidArgumentエラーに返されるエラーオブジェクトの配列。 すべての配列要素は、リクエスト引数で考えられるエラーの1つに対応します（例：引数の不正な値）。すべてのエラーには、code要素で返される独自の内部名、target要素（オプション）で返されるエラーの原因となる引数、およびmessage要素で返される説明があります。

ステータスコードとレスポンス形式

以下の表は、一般的なメソッドのステータスコードとレスポンス形式です。

以下は、コード400InvalidArgumentエラーのバリエーションです。