task list_all

Description

すべてのタスクの一覧を出力します。

注釈

出力されるタスクは、コマンドを実行した日の02:00(JST)頃の状態です。 最新の情報を出力したい場合は、 --latest を指定してください。

Examples

基本的な使い方

以下のコマンドは、すべてのタスクの一覧を出力します。

$ annofabcli task list_all --project_id prj1 --output task.csv

annofabcli task download コマンドでダウンロードできるタスク全件ファイルから、タスクの一覧を出力することもできます。

$ annofabcli task download --project_id prj1 --output task.json
$ annofabcli task list_all --project_id prj1 --task_json task.json

タスクのフェーズやステータスなどで絞り込み

--task_query を指定すると、タスクのフェーズやステータスなどで絞り込めます。 詳細は Command line options を参照してください。 以下のコマンドは、受入フェーズで未着手状態のタスクを出力します。

$ annofabcli task list_all --project_id prj1 \
 --task_query '{"status":"complete", "phase":"not_started"}'

task_idで絞り込み

--task_id を指定すると、task_idで絞り込めます。 以下のコマンドは、task_id.txt に記載されているtask_idに一致するタスクを出力します。

$ annofabcli task list_all --project_id prj1 --task_id file://task_id.txt

出力結果

annofabcli task list コマンドの出力結果と同じです。

Usage Details

すべてのタスクの一覧を出力します。 出力されるタスクは、コマンドを実行した日の02:00(JST)頃の状態です。最新の情報を出力したい場合は、 --latest を指定してください。

usage: annofabcli task list_all [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                [--annofab_user_id ANNOFAB_USER_ID]
                                [--annofab_password ANNOFAB_PASSWORD]
                                [--logdir LOGDIR] [--disable_log] [--debug] -p
                                PROJECT_ID [-tq TASK_QUERY]
                                [-t TASK_ID [TASK_ID ...]]
                                [--task_json TASK_JSON] [--latest]
                                [-f {csv,json,pretty_json,task_id_list}]
                                [-o OUTPUT] [--csv_format CSV_FORMAT]

Named Arguments

-p, --project_id

対象のプロジェクトのproject_idを指定します。

-tq, --task_query

タスクを絞り込むためのクエリ条件をJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 以下のキーを指定できます。

  • task_id

  • phase

  • phase_stage

  • status

  • user_id

  • account_id

  • no_user

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--task_json

タスク情報が記載されたJSONファイルのパスを指定すると、JSONに記載された情報を元にタスク一覧を出力します。 JSONファイルは $ annofabcli task download コマンドで取得できます。

--latest

最新のタスクの情報を出力します。このオプションを指定すると数分待ちます。Annofabからダウンロードする「タスク全件ファイル」に、最新の情報を反映させるのに時間がかかるためです。 指定しない場合は、コマンドを実行した日の02:00(JST)頃のタスクの一覧が出力されます。

-f, --format

Possible choices: csv, json, pretty_json, task_id_list

出力フォーマットを指定します。

Default: "csv"

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

--csv_format

CSVのフォーマットをJSON形式で指定します。 --formatcsv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 指定した値は pandas.DataFrame.to_csv の引数として渡されます。

global optional arguments

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: "https://annofab.com"

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。