task_history download#

Description#

タスク履歴全件ファイルをダウンロードします。

Examples#

基本的な使い方#

以下のコマンドを実行すると、タスク履歴全件ファイルがダウンロードされます。 タスク履歴全件ファイルのフォーマットについては https://annofab.com/docs/api/#section/TaskHistory を参照してください。

$ annofabcli task_history download --project_id prj1 --output task_history.json

タスク履歴の状態は、02:00(JST)頃にタスク履歴全件ファイルに反映されます。

出力結果#

$ annofabcli task_history download --output out.json
$ jq . out.json > out-pretty.json
out-pretty.json#
{
    "task1": [
        {
        "project_id": "prj1",
        "task_id": "task1",
        "task_history_id": "12345678-abcd-1234-abcd-1234abcd5678",
        "started_datetime": "2020-12-09T02:17:42.257+09:00",
        "ended_datetime": null,
        "accumulated_labor_time_milliseconds": "PT0S",
        "phase": "annotation",
        "phase_stage": 1,
        "account_id": null,
        },
        ...
    ],
    "task2": [
        {
        "project_id": "prj1",
        "task_id": "task2",
        "task_history_id": "22345678-abcd-1234-abcd-1234abcd5678",
        "started_datetime": "2020-12-09T02:17:42.257+09:00",
        "ended_datetime": null,
        "accumulated_labor_time_milliseconds": "PT0S",
        "phase": "annotation",
        "phase_stage": 1,
        "account_id": null,
        },
        ...
    ],

Usage Details#

タスク履歴全件ファイルをダウンロードします。

usage: annofabcli task_history download [-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 -o OUTPUT

Named Arguments#

-p, --project_id

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

-o, --output

ダウンロード先を指定します。

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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

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