task list_added_task_history#
Description#
タスク一覧に、タスク履歴に関する情報に加えたものを出力します。 タスク履歴に関する情報は、たとえば以下のような情報です。
フェーズごとの作業時間
各フェーズの最初の担当者と開始日時
各フェーズの最後の担当者と開始日時
最初に教師付けを開始した日時や担当者などを調べるのに、便利です。
Examples#
基本的な使い方#
$ annofabcli task list_added_task_history --project_id prj1 --output task.csv
警告
WebAPIの都合上、タスクは10,000件までしか出力できません。 10,000件以上のタスクを出力する場合は、annofabcli task list_all_added_task_history コマンドを使用してください。
タスクのフェーズやステータスなどで絞り込む#
--task_query
を指定すると、タスクのフェーズやステータスなどで絞り込めます。
--task_query
に渡す値は、https://annofab.com/docs/api/#operation/getTasks のクエリパラメータとほとんど同じです。
さらに追加で、user_id
, previous_user_id
キーも指定できます。
以下のコマンドは、受入フェーズで完了状態のタスク一覧を出力します。
$ annofabcli task list_added_task_history --project_id prj1 \
--task_query '{"status":"complete", "phase":"not_started"}'
task_id絞り込む#
--task_id
を指定すると、タスクIDで絞り込むことができます。
$ annofabcli task list_added_task_history --project_id prj1 \
--task_id task1 task2
出力結果#
JSON出力#
$ annofabcli task list_added_task_history --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": "12bc2dca-d519-419b-8da1-cd431d91e193",
"histories_by_phase": [
...
],
"work_time_span": 3110962,
"started_datetime": "2022-10-25T15:04:24.212+09:00",
"updated_datetime": "2022-10-25T15:14:18.986+09:00",
"operation_updated_datetime": "2022-10-25T15:14:18.986+09:00",
"sampling": null,
"metadata": {
"input_data_count": 20
},
"user_id": "alice",
"username": "Alice",
"worktime_hour": 0.8641561111111111,
"number_of_rejections_by_inspection": 1,
"number_of_rejections_by_acceptance": 0,
"input_data_count": 20,
"created_datetime": "2022-10-22T00:18:20.922+09:00",
"first_annotation_started_datetime": "2022-10-22T13:08:26.576+09:00",
"first_annotation_worktime_hour": 0.5416294444444444,
"first_annotation_user_id": "bob",
"first_annotation_username": "Bob",
"annotation_worktime_hour": 0.5879452777777777,
"first_inspection_started_datetime": "2022-10-25T09:44:00.589+09:00",
"first_inspection_worktime_hour": 0.08355916666666666,
"first_inspection_user_id": "chris",
"first_inspection_username": "Chris",
"inspection_worktime_hour": 0.1110011111111111,
"first_acceptance_started_datetime": "2022-10-25T15:04:24.212+09:00",
"first_acceptance_worktime_hour": 0.16520972222222222,
"first_acceptance_user_id": "alice",
"first_acceptance_username": "Alice",
"acceptance_worktime_hour": 0.16520972222222222,
"first_acceptance_reached_datetime": "2022-10-24T15:14:18.967+09:00",
"first_acceptance_completed_datetime": "2022-10-25T15:14:18.967+09:00",
"completed_datetime": "2022-10-25T15:14:18.967+09:00",
"inspection_is_skipped": false,
"acceptance_is_skipped": false
},
...
]
以下の項目は、タスク履歴から取得した情報です。
created_datetime: タスクの作成日時
annotation_worktime_hour: 教師付フェーズの作業時間[hour]
inspection_worktime_hour: 検査フェーズの作業時間[hour]
acceptance_worktime_hour: 受入フェーズの作業時間[hour]
first_acceptance_reached_datetime: はじめて受入フェーズに到達した日時。
first_annotation_started_datetime
より前の日時になるfirst_acceptance_completed_datetime: はじめて受入完了状態になった日時
completed_datetime: 受入完了状態になった日時
inspection_is_skipped: 抜取検査により検査フェーズがスキップされたかどうか
acceptance_is_skipped: 抜取受入により受入フェーズがスキップされたかどうか
first_annotation_user_id: 最初の教師付フェーズを担当したユーザのuser_id
first_annotation_username: 最初の教師付フェーズを担当したユーザの名前
first_annotation_started_datetime: 最初の教師付フェーズを開始した日時
...
Usage Details#
タスク履歴に関する情報(フェーズごとの作業時間、担当者、開始日時)を加えたタスク一覧を出力します。
usage: annofabcli task list_added_task_history [-h] [--yes]
[--endpoint_url ENDPOINT_URL]
[--annofab_user_id ANNOFAB_USER_ID]
[--annofab_password ANNOFAB_PASSWORD]
[--annofab_pat ANNOFAB_PAT]
[--mfa_code MFA_CODE]
[--logdir LOGDIR]
[--disable_log] [--debug] -p
PROJECT_ID
[-tq TASK_QUERY | -t TASK_ID [TASK_ID ...]]
[-o OUTPUT]
[-f {csv,json,pretty_json}]
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の一覧が記載されたファイルを指定できます。- -o, --output
出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。
- -f, --format
Possible choices: csv, json, pretty_json
出力フォーマットを指定します。
Default:
'csv'
global optional arguments#
- --yes
処理中に現れる問い合わせに対して、常に
yes
と回答します。- --endpoint_url
Annofab WebAPIのエンドポイントを指定します。
Default:
'https://annofab.com'
- --annofab_user_id
Annofabにログインする際のユーザーID
- --annofab_password
Annofabにログインする際のパスワード
- --annofab_pat
Annofabにログインする際のパーソナルアクセストークン
- --mfa_code
Annofabにログインする際のMFAコード
- --logdir
ログファイルを保存するディレクトリを指定します。
Default:
.log
- --disable_log
ログを無効にします。
- --debug
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。