task list¶
Description¶
タスク一覧を出力します。
Examples¶
基本的な使い方¶
--project_id に対象プロジェクトのproject_idを指定してください。
以下のコマンドは、すべてのタスクの一覧を出力します。 ただし10,000件までしか出力できません。
$ annofabcli task list --project_id prj1
警告
WebAPIの都合上、10,000件までしか出力できません。 10,000件以上のタスクを出力する場合は、annofabcli task list_all コマンドを使用してください。
タスクのフェーズやステータスなどで絞り込む¶
--task_query を指定すると、タスクのフェーズやステータスなどで絞り込めます。
--task_query に渡す値は、https://annofab.com/docs/api/#operation/getTasks のクエリパラメータとほとんど同じです。
さらに追加で、user_id , previous_user_id キーも指定できます。
以下のコマンドは、受入フェーズで完了状態のタスク一覧を出力します。
$ annofabcli task list --project_id prj1 \
--task_query '{"status":"complete", "phase":"acceptance"}'
task_idに sample を含むタスクの一覧を出力します。大文字小文字は区別しません。
$ annofabcli task list --project_id prj1 \
--task_query '{"task_id":"sample"}'
差し戻されたタスクの一覧を出力します。
$ annofabcli task list --project_id prj1 --task_query '{"rejected_only": true}'
過去の担当者が user1 であるタスクの一覧を出力します。
$ annofabcli task list --project_id prj1 --task_query '{"previous_user_id": "user1"}'
metadataの priority が 5 であるタスク一覧を出力します。
$ annofabcli task list --project_id prj1 --task_query '{"metadata": "priority:5"}'
タスクの担当者で絞り込む¶
タスクの担当者で絞り込む場合は、--user_id を指定してください。
$ annofabcli task list --project_id prj1 --user_id user1 user2
task_idで絞り込む¶
task_idで絞り込む場合は、 --task_id を指定してください。
$ annofabcli task list --project_id prj1 --task_id task1 task2
出力結果¶
JSON出力¶
$ annofabcli task list --project_id prj1 --format pretty_json --output out.json
[
{
"project_id": "prj1",
"task_id": "task1",
"phase": "acceptance",
"phase_stage": 1,
"status": "complete",
"input_data_id_list": [
"input1"
],
"account_id": "12345678-abcd-1234-abcd-1234abcd5678",
"histories_by_phase": [
{
"account_id": "12345678-abcd-1234-abcd-1234abcd5678",
"phase": "annotation",
"phase_stage": 1,
"worked": true,
"user_id": "test_user_id",
"username": "test_username"
},
...
],
"work_time_span": 8924136,
"started_datetime": "2020-11-24T16:21:27.753+09:00",
"updated_datetime": "2020-11-24T16:29:29.381+09:00",
"sampling": null,
"metadata": {},
"user_id": "test_user_id",
"username": "test_username",
"worktime_hour": 2.4789266666666667,
"number_of_rejections_by_inspection": 0,
"number_of_rejections_by_acceptance": 1
},
...
]
Usage Details¶
タスク一覧を出力します。
usage: annofabcli task list [-h] [--yes] [--endpoint_url ENDPOINT_URL]
[--logdir LOGDIR] [--disable_log] [--debug] -p
PROJECT_ID
[-tq TASK_QUERY | -t TASK_ID [TASK_ID ...]]
[-u USER_ID [USER_ID ...]]
[-f {csv,json,pretty_json,task_id_list}]
[-o OUTPUT] [--csv_format CSV_FORMAT] [-q QUERY]
Named Arguments¶
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- -tq, --task_query
タスクの検索クエリをJSON形式で指定します。指定しない場合は、すべてのタスクを取得します。
file://を先頭に付けると、JSON形式のファイルを指定できます。クエリのフォーマットは、getTasks APIのクエリパラメータと同じです。さらに追加で、user_id,previous_user_idキーも指定できます。ただしpage,limitキーは指定できません。- -t, --task_id
対象のタスクのtask_idを指定します。
--task_query引数とは同時に指定できません。file://を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。- -u, --user_id
絞り込み対象である担当者のuser_idを指定します。
file://を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。- -f, --format
Possible choices: csv, json, pretty_json, task_id_list
出力フォーマットを指定します。
Default: "csv"
- -o, --output
出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。
- --csv_format
CSVのフォーマットをJSON形式で指定します。
--formatがcsvでないときは、このオプションは無視されます。file://を先頭に付けると、JSON形式のファイルを指定できます。 指定した値はpandas.DataFrame.to_csvの引数として渡されます。- -q, --query
JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。
global optional arguments¶
- --yes
処理中に現れる問い合わせに対して、常に
yesと回答します。- --endpoint_url
Annofab WebAPIのエンドポイントを指定します。
Default: "https://annofab.com"
- --logdir
ログファイルを保存するディレクトリを指定します。
Default: .log
- --disable_log
ログを無効にします。
- --debug
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。