annotation_specs update_attributes#
Description#
アノテーション仕様の既存属性に設定された英語名、日本語名、ベトナム語名、キーバインド、 read_only 、 default_value を更新します。
JSON形式では、既存選択肢の英語名、日本語名、ベトナム語名、ショートカットキーも同時に更新できます。
attribute_id 、属性種類、選択肢の削除、選択肢の並び順、所属先ラベルは既存アノテーションへの影響を避けるため更新できません。
Examples#
JSON形式で指定する場合#
[
{
"attribute_id": "54fa5e97-6f88-49a4-aeb0-a91a15d11528",
"attribute_name_en": "comment",
"attribute_name_ja": "コメント",
"attribute_name_vi": "bình luận",
"keybind": {
"alt": false,
"code": "Digit1",
"ctrl": true,
"shift": false
},
"read_only": false,
"default_value": "確認済み"
},
{
"attribute_id": "f12a0b59-dfce-4241-bb87-4b2c0259fc6f",
"read_only": true,
"default_value": true
},
{
"attribute_id": "71620647-98cf-48ad-b43b-4af425a24f32",
"attribute_name_ja": "種別",
"choice_updates": [
{
"choice_id": "08ec927c-18e6-4bba-837a-b16de7061580",
"choice_name_en": "large",
"choice_name_ja": "大",
"choice_name_vi": "lớn",
"keybind": {
"alt": false,
"code": "Digit2",
"ctrl": true,
"shift": false
}
},
{
"choice_id": "74691a87-7962-4fa9-ba52-7cc466ecd982",
"keybind": null
}
]
}
]
$ annofabcli annotation_specs update_attributes \
--project_id prj1 \
--attribute_json file://attributes.json
--attribute_json には、属性更新情報のJSON配列を指定してください。配列の各要素が1件の属性に対応します。
キー |
必須 |
説明 |
|---|---|---|
|
必須 |
更新対象属性の |
|
任意 |
更新後の属性英語名。 |
|
任意 |
更新後の属性日本語名。 |
|
任意 |
更新後の属性ベトナム語名。 |
|
任意 |
更新後のキーボードショートカットのJSONオブジェクト。省略すると既存値を保持し、 |
|
任意 |
更新後の読み込み専用設定。 |
|
任意 |
更新後の初期値。属性の種類が |
|
任意 |
既存選択肢の更新情報の配列。選択肢系属性でのみ指定できます。 |
choice_updates には、既存選択肢の更新情報を指定してください。配列の各要素が1件の選択肢に対応します。
キー |
必須 |
説明 |
|---|---|---|
|
必須 |
更新対象選択肢の |
|
任意 |
更新後の選択肢英語名。 |
|
任意 |
更新後の選択肢日本語名。 |
|
任意 |
更新後の選択肢ベトナム語名。 |
|
任意 |
更新後のキーボードショートカットのJSONオブジェクト。 |
CSV形式で指定する場合#
attribute_id,attribute_name_en,attribute_name_ja,attribute_name_vi,keybind,read_only,default_value
54fa5e97-6f88-49a4-aeb0-a91a15d11528,comment,コメント,bình luận,"{""alt"": false, ""code"": ""Digit1"", ""ctrl"": true, ""shift"": false}",false,確認済み
f12a0b59-dfce-4241-bb87-4b2c0259fc6f,,,,,true,true
CSV形式では、 keybind 列だけはJSONオブジェクト文字列として指定してください。
そのため、CSVセル全体を " で囲み、JSON内の " は "" のようにエスケープする必要があります。
CSVの keybind 列の省略・空欄は既存値を保持します。解除する場合はJSON形式で null を指定してください。
CSV形式では選択肢情報は更新できません。選択肢情報も同時に更新したい場合はJSON形式を利用してください。
$ annofabcli annotation_specs update_attributes \
--project_id prj1 \
--attribute_csv attributes.csv
Usage Details#
アノテーション仕様の既存属性に設定された英語名、日本語名、ベトナム語名、キーバインド、read_only、default_value と、既存選択肢の名前、ショートカットキーを更新します。
usage: annofabcli annotation_specs update_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 | --attribute_csv ATTRIBUTE_CSV)
[--comment COMMENT]
Named Arguments#
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- --attribute_json
更新する属性情報のJSON配列を指定します。
file://を先頭に付けるとJSON形式のファイルを指定できます。 各要素には更新対象を示すattribute_idが必要です。 任意で更新後のattribute_name_en,attribute_name_ja,attribute_name_vi,keybind,read_only,default_value,choice_updatesを指定できます。keybindを省略すると既存値を保持し、nullを指定するとショートカットキーを解除します。choice_updatesでは既存選択肢のchoice_name_en,choice_name_ja,choice_name_vi,keybindを更新できます。 (例)[{"attribute_id": "54fa5e97-6f88-49a4-aeb0-a91a15d11528", "attribute_name_en": "comment", "attribute_name_ja": "コメント", "attribute_name_vi": "bình luận", "keybind": {"alt": false, "code": "Digit1", "ctrl": true, "shift": false}, "read_only": false, "default_value": "確認済み"}, {"attribute_id": "71620647-98cf-48ad-b43b-4af425a24f32", "attribute_name_ja": "種別", "choice_updates": [{"choice_id": "08ec927c-18e6-4bba-837a-b16de7061580", "choice_name_ja": "大", "keybind": {"alt": false, "code": "Digit2", "ctrl": true, "shift": false}}, {"choice_id": "74691a87-7962-4fa9-ba52-7cc466ecd982", "keybind": null}]}, {"attribute_id": "f12a0b59-dfce-4241-bb87-4b2c0259fc6f", "read_only": true, "default_value": true}]- --attribute_csv
更新する属性情報のCSVファイルを指定します。 CSVには更新対象を示す
attribute_id列が必要です。 任意で更新後のattribute_name_en,attribute_name_ja,attribute_name_vi,keybind,read_only,default_value列を指定できます。keybind列にはJSONオブジェクト文字列を指定してください。- --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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。