task download

Description

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

Examples

基本的な使い方

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

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

タスクの状態は、02:00(JST)頃にタスク全件ファイルに反映されます。 現在のタスクの状態をタスク全件ファイルに反映させたい場合は、--latest を指定してください。 タスク全件ファイルへの反映が完了したら、ダウンロードされます。 ただし、データ数に応じて数分から数十分待ちます。

$ annofabcli task download --project_id prj1 --output task.json --latest

出力結果

$ annofabcli task download --output out.json
$ jq . out.json > out-pretty.json
out-pretty.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,
      },
      ...
    ],
    "work_time_span": 8924136,
    "started_datetime": "2020-11-24T16:21:27.753+09:00",
    "updated_datetime": "2020-11-24T16:29:29.381+09:00",
    "operation_updated_datetime": "2020-11-24T16:29:29.381+09:00",
    "sampling": null,
    "metadata": {},
  },
  ...
]

Usage Details

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

usage: annofabcli task download [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                [--annofab_user_id ANNOFAB_USER_ID]
                                [--annofab_password ANNOFAB_PASSWORD]
                                [--logdir LOGDIR] [--disable_log] [--debug] -p
                                PROJECT_ID -o OUTPUT [--latest]

Named Arguments

-p, --project_id

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

-o, --output

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

--latest

現在のタスクの状態をタスク全件ファイルに反映させてから、ダウンロードします。タスク全件ファイルへの反映には、データ数に応じて数分から数十分かかります。

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

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