annotation_specs add_choices_to_attributes#

Description#

既存の複数選択肢系属性（ラジオボタン/ドロップダウン）に、選択肢を追加します。

複数属性への選択肢追加を1回のアノテーション仕様更新として実行できます。 1つの属性にだけ選択肢を追加したい場合は annotation_specs add_choices_to_attribute も利用できます。

attribute_id 、既存選択肢の内容・相対的な並び順、属性の default_value は変更できません。属性の default_value を変更したい場合は annotation_specs update_attributes を利用してください。

Examples#

JSON形式で指定する場合#

attributes.json#

[
    {
        "attribute_id": "71620647-98cf-48ad-b43b-4af425a24f32",
        "choices": [
            {
                "choice_id": "xlarge",
                "choice_name_en": "xlarge",
                "choice_name_ja": "特大",
                "choice_name_vi": "rất lớn"
            },
            {
                "choice_id": "tiny",
                "choice_name_en": "tiny",
                "choice_name_ja": "極小"
            }
        ]
    },
    {
        "attribute_id": "e6d5bf13-9bf5-4c31-8a81-2d8a772c9468",
        "choices": [
            {
                "choice_name_en": "rainy",
                "choice_name_ja": "雨",
                "keybind": {
                    "alt": false,
                    "code": "Digit1",
                    "ctrl": true,
                    "shift": false
                }
            }
        ]
    }
]

$ annofabcli annotation_specs add_choices_to_attributes \
 --project_id prj1 \
 --attribute_json file://attributes.json

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

キー	必須	説明
`attribute_id`	必須	選択肢を追加する対象属性の `attribute_id` 。
`before_choice_name_en`	任意	基準となる既存選択肢の英語名。この選択肢の直前に追加します。
`choices`	必須	追加する選択肢情報の配列。1件以上指定してください。

choices には、追加する選択肢情報を指定してください。配列の各要素が1件の選択肢に対応します。

キー	必須	説明
`choice_name_en`	必須	追加する選択肢の英語名。
`choice_id`	任意	追加する選択肢の `choice_id` 。未指定の場合はUUIDv4が自動生成されます。
`choice_name_ja`	任意	追加する選択肢の日本語名。
`choice_name_vi`	任意	追加する選択肢のベトナム語名。
`keybind`	任意	キーボードショートカットのJSONオブジェクト。 `code` に指定できる値は、 KeyboardEvent.code を参照してください。
`is_default`	任意	指定されても無視されます。デフォルト値を変更したい場合は annotation_specs update_attributes を利用してください。

追加位置の指定#

JSONの各対象属性オブジェクトに、任意の before_choice_name_en を指定できます。各属性の choices 配列を入力順のまま、指定した既存選択肢の直前に挿入します。位置指定とエラー条件は annotation_specs add_choices_to_attribute と同じです。いずれかの属性の位置指定が不正な場合は、更新全体をエラーにします。

[
    {
        "attribute_id": "size_attribute_id",
        "before_choice_name_en": "large",
        "choices": [
            {"choice_name_en": "medium"}
        ]
    }
]

Usage Details#

既存の複数選択肢系属性（ラジオボタン/ドロップダウン）に、選択肢を追加します。

usage: annofabcli annotation_specs add_choices_to_attributes
       [-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_json ATTRIBUTE_JSON [--comment COMMENT]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
--attribute_json: 選択肢を追加する属性情報のJSON配列を指定します。 file:// を先頭に付けるとJSON形式のファイルを指定できます。各要素には追加先を示す attribute_id と、追加する選択肢情報の choices が必要です。 choices では任意で choice_id , choice_name_ja , choice_name_vi , keybind を指定できます。 is_default は無視されます。 (例) [{"attribute_id": "71620647-98cf-48ad-b43b-4af425a24f32", "choices": [{"choice_id": "xlarge", "choice_name_en": "xlarge", "choice_name_ja": "特大", "choice_name_vi": "rất lớn"}, {"choice_id": "tiny", "choice_name_en": "tiny", "choice_name_ja": "極小"}]}, {"attribute_id": "e6d5bf13-9bf5-4c31-8a81-2d8a772c9468", "choices": [{"choice_name_en": "rainy", "choice_name_ja": "雨", "keybind": {"alt": false, "code": "Digit1", "ctrl": true, "shift": false}}]}]
--comment: アノテーション仕様の変更内容を説明するコメント。未指定の場合、自動でコメントが生成されます。

common options (after the subcommand)#

--yes

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

--endpoint_url

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

--annofab_user_id

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

--annofab_password

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

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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