listTasks メソッド

Open documentation menuClose documentation menu

このメソッドは、アプリケーションが作成したタスクのリストを返します。デフォルトでは Deleted されたタスクも含まれますが、除外することもできます。このメソッドは、一定期間のアプリケーション利用ログを作成する際に便利です。

アプリケーション処理ロケーションに応じて以下のリクエストURLを編集してください：

[GET] https://<PROCESSING_LOCATION_ID>.ocrsdk.com/v2/listTasks

タスクは、最後のアクションが発生した日付順になっています。 Tこのメソッドは、1,000タスクまでをリストアップすることができます。 大量のタスクを処理する場合、短い期間に対してこのメソッドを呼び出しましょう。

パラメータ

パラメータ 必須 既定値 説明
fromDate いいえ 現在の日付－7日間 リストを作成するタスクの開始日を指定します。 日付はW3C XML DateTimeの日付形式（例：yyyy-mm-ddThh:mm:ssZ)で指定します。
toDate いいえ 現在の日付 リストを作成するタスクの終了日を指定します。日付はW3C XML DateTimeの日付形式（例：yyyy-mm-ddThh:mm:ssZ)で指定します。
excludeDeleted いいえ "false"

すでに削除されたタスクをリストから除外する場合に指定します。パラメータには、以下のいずれかの値が入ります：

  • true
  • false

ステータスコード

メソッドの全般的なステータスコードはHTTPステータスコードとレスポンス形式で確認できます。

レスポンス形式

結果はJSONレスポンスとして返されます。 JSONレスポンスの書式は以下の通りです：

{
    "tasks":
    [
        <task1>,
        <task2>,
        ...
    ]
}