annotation_specs delete_choices

Description

アノテーション仕様の選択肢系属性（ラジオボタン/ドロップダウン）から選択肢を削除します。 削除対象選択肢に関連する属性制約も削除します。

Examples

選択肢名を指定して削除する

以下のコマンドは、"type" 属性から "large", "medium" 選択肢を削除します。

$ annofabcli annotation_specs delete_choices \
 --project_id prj1 \
 --attribute_name_en type \
 --choice_name_en large medium

選択肢IDを指定して削除する

$ annofabcli annotation_specs delete_choices \
 --project_id prj1 \
 --attribute_id 71620647-98cf-48ad-b43b-4af425a24f32 \
 --choice_id choice_large choice_medium

デフォルト値に設定されている選択肢を削除する

削除対象選択肢が属性のデフォルト値に設定されている場合は、デフォルトでは削除できません。 デフォルト値を解除した上で選択肢を削除する場合は、 --unsafe_defaults を指定してください。

$ annofabcli annotation_specs delete_choices \
 --project_id prj1 \
 --attribute_name_en type \
 --choice_name_en large \
 --unsafe_defaults

既存アノテーションに影響する変更を許可する

削除対象選択肢が既存アノテーションで使われている場合は、デフォルトでは削除できません。 既存アノテーションに影響することを理解した上で選択肢を削除する場合は、 --allow_affecting_annotations を指定してください。

$ annofabcli annotation_specs delete_choices \
 --project_id prj1 \
 --attribute_name_en type \
 --choice_name_en large \
 --allow_affecting_annotations

Usage Details

アノテーション仕様の選択肢系属性から選択肢を複数件削除します。

usage: annofabcli annotation_specs delete_choices [-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
                                                  (--attribute_name_en ATTRIBUTE_NAME_EN | --attribute_id ATTRIBUTE_ID)
                                                  (--choice_name_en CHOICE_NAME_EN [CHOICE_NAME_EN ...] | --choice_id CHOICE_ID [CHOICE_ID ...])
                                                  [--allow_affecting_annotations]
                                                  [--unsafe_defaults]
                                                  [--comment COMMENT]

Named Arguments

-p, --project_id

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

--attribute_name_en

選択肢を削除する対象属性の英語名。

--attribute_id

選択肢を削除する対象属性の属性ID。

--choice_name_en

削除する選択肢の英語名。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。

--choice_id

削除する選択肢のchoice_id。複数指定できます。 file:// を先頭に付けると一覧ファイルを指定できます。

--allow_affecting_annotations

指定すると、既存アノテーションに影響する変更でも選択肢を削除します。

--unsafe_defaults

指定すると、削除対象選択肢が属性のデフォルト値に設定されている場合でも、デフォルト値を解除して選択肢を削除します。

--comment

アノテーション仕様の変更内容を説明するコメント。未指定の場合、自動でコメントが生成されます。

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