task list_added_task_history

Description

タスク一覧に、タスク履歴から取得した以下の情報を追加して、CSV形式で出力します。

  • フェーズごとの作業時間

  • 各フェーズの最初の担当者と開始日時

  • 各フェーズの最後の担当者と開始日時

最初に教師付を開始した日時や担当者などを調べるのに利用できます。

Examples

基本的な使い方

以下のコマンドは、タスク全件ファイルとタスク履歴全件ファイルをダウンロードしてから、タスク一覧を出力します。

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

タスク全件ファイルを指定する場合は --task_json 、タスク履歴全件ファイルを指定する場合は --task_history_json を指定してください。

$ annofabcli task list_added_task_history --project_id prj1 --output task.csv \
--task_json task.json --task_history_json task_history.json

タスク全件ファイルは`annofabcli task download <../task/download.html>`_ コマンド、タスク履歴全件ファイルは、annofabcli task_history download コマンドでダウンロードできます。

タスクの絞り込み

--task_query--task_id で、タスクを絞り込むことができます。

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

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

出力結果

CSV出力

$ annofabcli task list_added_task_history --project_id prj1 --output out.csv

out.csv

出力されたCSVの以下の列は、タスク履歴から取得した情報です。

  • annotation_worktime_hour: 教師付フェーズの作業時間[hour]

  • inspection_worktime_hour: 検査フェーズの作業時間[hour]

  • acceptance_worktime_hour: 受入フェーズの作業時間[hour]

  • 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: 最初の教師付フェーズを開始した日時

  • ...

  • last_acceptance_user_id: 最後の受入フェーズを担当したユーザのuser_id

  • last_acceptance_username: 最後の受入フェーズを担当したユーザの名前

  • last_acceptance_started_datetime: 最後の受入フェーズを開始した日時

Usage Details

タスク履歴情報(フェーズごとの作業時間、担当者、開始日時)を加えたタスク一覧をCSV形式で出力します。

usage: annofabcli task list_added_task_history [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug] -p
                                               PROJECT_ID [-tq TASK_QUERY]
                                               [-t TASK_ID [TASK_ID ...]]
                                               [--task_json TASK_JSON]
                                               [--task_history_json TASK_HISTORY_JSON]
                                               [--latest]
                                               [--wait_options WAIT_OPTIONS]
                                               [-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ファイルをダウンロードします。JSONファイルは`$ annofabcli task download`コマンドで取得できます。

--task_history_json

タスク履歴情報が記載されたJSONファイルのパスを指定すると、JSONに記載された情報を元に出力します。指定しない場合はJSONファイルをダウンロードします。JSONファイルは`$ annofabcli task_history download`コマンドで取得できます。

--latest

タスク一覧ファイルの更新が完了するまで待って、最新のファイルをダウンロードします(タスク履歴ファイルはWebAPIの都合上更新されません)。JSONファイルを指定しなかったときに有効です。

--wait_options

タスク一覧ファイルの更新が完了するまで待つ際のオプションを、JSON形式で指定してください。file://`を先頭に付けるとjsonファイルを指定できます。デフォルは`{"interval":60, "max_tries":360} です。interval:完了したかを問い合わせる間隔[秒], max_tires:完了したかの問い合わせを最大何回行うか。

-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"

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

アノテーションユーザ/オーナロールを持つユーザで実行してください。