supplementary list#

Description#

補助情報一覧を出力します。

Examples#

基本的な使い方#

以下のコマンドは、指定した入力データに紐づく補助情報を出力します。

$ annofabcli supplementary list --project_id prj1 --input_data_id input1 input2

以下のコマンドは、指定したタスクに紐づく補助情報を出力します。

$ annofabcli supplementary list --project_id prj1 --task_id task1 task2

出力結果#

CSV出力#

$ annofabcli supplementary list --format csv --output out.csv

out.csv

JSON出力#

$ annofabcli supplementary list --input_data_id file://input_data_id.txt --format pretty_json --output out.json

out.json#

[
{
    "project_id": "prj1",
    "organization_id": "org1",
    "input_data_id": "input1",
    "input_data_set_id": "12345678-abcd-1234-abcd-1234abcd5678",
    "supplementary_data_id": "supplementary1",
    "supplementary_data_name": "test-supplementary1",
    "supplementary_data_path": "s3://af-production-input/organizations/...",
    "url": "https://annofab.com/organizations/...",
    "etag": "...",
    "supplementary_data_type": "image",
    "supplementary_data_number": 1,
    "updated_datetime": "2021-01-04T22:02:36.33+09:00"
},
...
]

Usage Details#

補助情報一覧を出力します。

usage: annofabcli supplementary list [-h] [--yes]
                                     [--endpoint_url ENDPOINT_URL]
                                     [--annofab_user_id ANNOFAB_USER_ID]
                                     [--annofab_password ANNOFAB_PASSWORD]
                                     [--logdir LOGDIR] [--disable_log]
                                     [--debug] -p PROJECT_ID
                                     (-t TASK_ID [TASK_ID ...] | -i INPUT_DATA_ID [INPUT_DATA_ID ...])
                                     [-f {csv,json,pretty_json}] [-o OUTPUT]
                                     [--csv_format CSV_FORMAT] [-q QUERY]

Named Arguments#

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

-i, --input_data_id

対象の入力データのinput_data_idを指定します。 file:// を先頭に付けると、input_data_idの一覧が記載されたファイルを指定できます。

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマットを指定します。

Default: "csv"

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

--csv_format

CSVのフォーマットをJSON形式で指定します。 --format が csv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。指定した値は pandas.DataFrame.to_csv の引数として渡されます。

-q, --query

JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。

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