annotation_specs list_choice#

Description#

アノテーション仕様のドロップダウンまたはラジオボタン属性の選択肢情報を出力します。

Examples#

$ annofabcli annotation_specs list_choice --project_id prj1 --output out.csv

出力結果#

JSON出力#

$ annofabcli annotation_specs list_choice --project_id prj1 --format pretty_json --output out.json

out.json#

[
{
    "attribute_id": "a0f7c8ed-38dc-41e6-a18c-29a36d3e28f2",
    "attribute_name_en": "direction",
    "attribute_type": "select",
    "choice_id": "3475515f-ba44-4a8d-b32b-72635e420048",
    "choice_name_en": "rear",
    "choice_name_ja": "rear",
    "choice_name_vi": "rear",
    "is_default": false,
    "keybind": ""
},
{
    "attribute_id": "a0f7c8ed-38dc-41e6-a18c-29a36d3e28f2",
    "attribute_name_en": "direction",
    "attribute_type": "select",
    "choice_id": "a5ebf59b-0484-446d-ac11-14a4736026e4",
    "choice_name_en": "front",
    "choice_name_ja": "front",
    "choice_name_vi": "front",
    "is_default": false,
    "keybind": ""
},
]

attribute_id : 属性ID
attribute_name_en : 属性名（英語）
attribute_type : 属性の種類
choice_id : 選択肢ID
choice_name_en : 選択肢名（英語）
choice_name_ja : 選択肢名（日本語）
choice_name_vi : 選択肢名（ベトナム語）
is_default : 初期値として設定されているかどうか
keybind : キーボードショートカット

Usage Details#

アノテーション仕様のドロップダウンまたはラジオボタン属性の選択肢情報を出力します。

usage: annofabcli annotation_specs list_choice [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--annofab_user_id ANNOFAB_USER_ID]
                                               [--annofab_password ANNOFAB_PASSWORD]
                                               [--annofab_pat ANNOFAB_PAT]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug]
                                               (-p PROJECT_ID | --annotation_specs_json_file ANNOTATION_SPECS_JSON_FILE)
                                               [--history_id HISTORY_ID | --before BEFORE]
                                               [-f {csv,json,pretty_json}]
                                               [-o OUTPUT]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。APIで取得したアノテーション仕様情報を元に出力します。

--annotation_specs_json_file

指定したアノテーション仕様のJSONファイルを指定します。JSONファイルに記載された情報を元に出力します。ただしアノテーション仕様の format_version は 3 である必要があります。

--history_id

出力したいアノテーション仕様のhistory_idを指定してください。 history_idは annotation_specs list_history コマンドで確認できます。指定しない場合は、最新のアノテーション仕様が出力されます。

--before

出力したい過去のアノテーション仕様が、最新よりいくつ前のアノテーション仕様であるかを指定してください。たとえば 1 を指定した場合、最新より1個前のアノテーション仕様を出力します。指定しない場合は、最新のアノテーション仕様が出力されます。

-f, --format

Possible choices: csv, json, pretty_json

出力フォーマット

Default: 'csv'

-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にログインする際のパーソナルアクセストークン

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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