input_data list_all

Description

すべての入力データの一覧を出力します。

注釈

出力される入力データは、コマンドを実行した日の02:00(JST)頃の状態です(入力データ全件ファイルを明示的に更新しない限り)。 最新の入力データを出力したい場合は、 --latest 引数を指定してください。

Examples

基本的な使い方

以下のコマンドは、すべての入力データの一覧を出力します。

$ annofabcli input_data list_all --project_id prj1

annofabcli input_data download コマンドでダウンロードできる入力データ全件ファイルから、入力データの一覧を出力することもできます。

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

絞り込み

--input_data_query を指定すると、入力データの名前や入力データのパスで絞り込めます。 詳細は Command line options を参照してください。 以下のコマンドは、入力データ名に"sample"を含む入力データの一覧を出力します。

$ annofabcli input_data list_all --project_id prj1  \
 --input_data_query '{"input_data_name": "sample"}'

--input_data_id を指定すると、input_data_idに合致する入力データの一覧を出力します。

$ annofabcli input_data list_all --project_id prj1 \
 --input_data_id file://input_data_id.txt

出力結果

annofabcli input_data list コマンドの出力結果と同じです。

Usage Details

すべての入力データの一覧を出力します。 出力される入力データは、コマンドを実行した日の02:00(JST)頃の状態です。最新の情報を出力したい場合は、 --latest を指定してください。

usage: annofabcli input_data list_all_input_data [-h] [--yes]
                                                 [--endpoint_url ENDPOINT_URL]
                                                 [--annofab_user_id ANNOFAB_USER_ID]
                                                 [--annofab_password ANNOFAB_PASSWORD]
                                                 [--logdir LOGDIR]
                                                 [--disable_log] [--debug] -p
                                                 PROJECT_ID
                                                 [-iq INPUT_DATA_QUERY]
                                                 [-i INPUT_DATA_ID [INPUT_DATA_ID ...]]
                                                 [--input_data_json INPUT_DATA_JSON]
                                                 [--latest]
                                                 [-f {csv,json,pretty_json,input_data_id_list}]
                                                 [-o OUTPUT]
                                                 [--csv_format CSV_FORMAT]

Named Arguments

-p, --project_id

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

-iq, --input_data_query

入力データの検索クエリをJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 (ex) {"input_data_name": "sample"}

以下のキーを指定できます。

  • input_data_id

  • input_data_name

  • input_data_path

-i, --input_data_id

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

--input_data_json

入力データ情報が記載されたJSONファイルのパスを指定すると、JSONに記載された情報を元に入力データ一覧を出力します。 JSONファイルは $ annofabcli input_data download コマンドで取得できます。

--latest

最新の入力データの情報を出力します。このオプションを指定すると数分待ちます。Annofabからダウンロードする「入力データ全件ファイル」に、最新の情報を反映させるのに時間がかかるためです。 指定しない場合は、コマンドを実行した日の02:00(JST)頃の入力データの一覧が出力されます。

-f, --format

Possible choices: csv, json, pretty_json, input_data_id_list

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

Default: "csv"

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

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

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