annotation_specs update_choices#

Description#

アノテーション仕様の既存選択肢に設定された日本語名、ショートカットキーを更新します。

choice_id 、選択肢名(英語)、選択肢の並び順、属性の default_value は更新できません。選択肢の並び順を変更したい場合は annotation_specs reorder_choices を、属性の default_value を変更したい場合は annotation_specs update_attributes を利用してください。

Examples#

JSON形式で指定する場合#

choices.json#

[
    {
        "choice_name_en": "large",
        "choice_name_ja": "大",
        "keybind": {
            "alt": false,
            "code": "Digit1",
            "ctrl": true,
            "shift": false
        }
    },
    {
        "choice_id": "74691a87-7962-4fa9-ba52-7cc466ecd982",
        "keybind": null
    }
]

$ annofabcli annotation_specs update_choices \
 --project_id prj1 \
 --attribute_name_en type \
 --choice_json file://choices.json

--choice_json には、選択肢更新情報のJSON配列を指定してください。配列の各要素が1件の選択肢に対応します。

キー	必須	説明
`choice_id`	条件付き必須	更新対象選択肢の `choice_id` 。 `choice_name_en` とどちらか一方を指定してください。
`choice_name_en`	条件付き必須	更新対象選択肢の英語名。 `choice_id` とどちらか一方を指定してください。この値自体は更新されません。
`choice_name_ja`	任意	更新後の選択肢日本語名。
`keybind`	任意	更新後のキーボードショートカットのJSONオブジェクト。 `null` を指定するとショートカットキーを解除します。 `code` に指定できる値は、 KeyboardEvent.code を参照してください。

CSV形式で指定する場合#

choices.csv#

choice_id,choice_name_en,choice_name_ja,keybind
,large,大,"{""alt"": false, ""code"": ""Digit1"", ""ctrl"": true, ""shift"": false}"
74691a87-7962-4fa9-ba52-7cc466ecd982,,小,

CSV形式では、 keybind 列だけはJSONオブジェクト文字列として指定してください。

$ annofabcli annotation_specs update_choices \
 --project_id prj1 \
 --attribute_id 71620647-98cf-48ad-b43b-4af425a24f32 \
 --choice_csv choices.csv

Usage Details#

アノテーション仕様の既存選択肢に設定された日本語名、ショートカットキーを更新します。

usage: annofabcli annotation_specs update_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_id ATTRIBUTE_ID | --attribute_name_en ATTRIBUTE_NAME_EN)
                                                  (--choice_json CHOICE_JSON | --choice_csv CHOICE_CSV)
                                                  [--comment COMMENT]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--attribute_id: 選択肢を更新する対象属性の属性ID。
--attribute_name_en: 選択肢を更新する対象属性の英語名。
--choice_json: 更新する選択肢情報のJSON配列を指定します。 file:// を先頭に付けるとJSON形式のファイルを指定できます。各要素には choice_id または choice_name_en のどちらか一方が必要です。任意で choice_name_ja , keybind を指定できます。 keybind に null を指定するとショートカットキーを解除します。 (例) [{"choice_name_en": "large", "choice_name_ja": "大", "keybind": {"alt": false, "code": "Digit1", "ctrl": true, "shift": false}}, {"choice_id": "74691a87-7962-4fa9-ba52-7cc466ecd982", "keybind": null}]
--choice_csv: 更新する選択肢情報のCSVファイルを指定します。 CSVには choice_id または choice_name_en 列のどちらか一方が必要です。任意で choice_name_ja , keybind 列を指定できます。 keybind 列にはJSONオブジェクト文字列を指定してください。空欄の場合はショートカットキーを変更しません。
--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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。