Ctrl+K

annotation_specs get_with_attribute_id_replaced_english_name#

Description#

属性IDをUUIDから英語名に置換したアノテーション仕様のJSONを出力します。

アノテーション仕様は変更しません。画面のインポート機能を使って、アノテーション仕様を変更することを想定しています。

相関制約をJSONで直接設定する際などに利用すると便利です。IDをがUUID形式から分かりやすい名前になるため、JSON記述しやすくなります。

警告

既にアノテーションが存在する状態で属性IDを変更すると、既存のアノテーション情報が消える恐れがあります。十分注意して、属性IDを変更してください。

Examples#

基本的な使い方#

# 属性IDを英語名に変更したアノテーション仕様を出力
$ annofabcli annotation_specs get_with_attribute_id_replaced_english_name --project_id prj1 --out out.json

特定の属性の属性IDのみ変更する場合は、 --attribute_name を指定してください。

$ annofabcli annotation_specs get_with_label_id_replaced_english_name --project_id prj1 \
 --attribute_name type  --out out.json

Usage Details#

属性IDをUUIDから英語名に置換したアノテーション仕様のJSONを出力します。 アノテーション仕様は変更しません。画面のインポート機能を使って、アノテーション仕様を変更することを想定しています。 相関制約をJSONで直接設定する際などに利用すると便利です。IDをがUUID形式から分かりやすい名前になるため、JSON記述しやすくなります。 【注意】既にアノテーションが存在する状態で属性IDを変更すると、既存のアノテーション情報が消える恐れがあります。十分注意して、属性IDを変更してください。

usage: annofabcli annotation_specs get_with_label_id_replaced_english_name
       [-h] [--yes] [--endpoint_url ENDPOINT_URL]
       [--annofab_user_id ANNOFAB_USER_ID]
       [--annofab_password ANNOFAB_PASSWORD] [--mfa_code MFA_CODE]
       [--logdir LOGDIR] [--disable_log] [--debug] -p PROJECT_ID
       [--attribute_name ATTRIBUTE_NAME [ATTRIBUTE_NAME ...]] [-o OUTPUT]
       [-f {json,pretty_json}]

Named Arguments#

-p, --project_id

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

--attribute_name

置換対象の属性の英語名

-o, --output

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

-f, --format

Possible choices: json, pretty_json

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

Default: "pretty_json"

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: "https://annofab.com"

--annofab_user_id

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

--annofab_password

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

--mfa_code

Annofabにログインする際のMFAコード

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

On this page
Edit on GitHub