input_data download¶

Description¶

入力データ全件ファイルをダウンロードします。

Examples¶

基本的な使い方¶

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

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

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

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

出力結果¶

$ annofabcli input_data download --output out.json
$ jq . out.json > out-pretty.json

out-pretty.json¶

[
    {
        "input_data_id": "input1",
        "project_id": "prj1",
        "organization_id": "org1",
        "input_data_set_id": ",12345678-abcd-1234-abcd-1234abcd5678",
        "input_data_name": "data1",
        "input_data_path": "s3://af-production-input/organizations/...",
        "url": "https://annofab.com/organizations/...",
        "etag": "...",
        "updated_datetime": "2021-01-04T21:21:28.169+09:00",
        "original_input_data_path": "s3://af-production-input/organizations/...",
        "sign_required": false,
        "metadata": {},
        "system_metadata": {
            "resized_resolution": null,
            "original_resolution": {
                "width": 128,
                "height": 128
            }
        },
        "_type": "Image"
    },
    ...
]

Usage Details¶

入力データ全件ファイルをダウンロードします。

usage: annofabcli input_data download [-h] [--yes]
                                      [--endpoint_url ENDPOINT_URL]
                                      [--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"

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

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

input_data delete input_data list