annotation_specs update_attributes#

Description#

アノテーション仕様の既存属性に設定された日本語名、キーバインド、 read_only 、 default_value を更新します。

attribute_id 、属性名(英語)、属性種類、選択肢、所属先ラベルは既存アノテーションへの影響を避けるため更新できません。

Examples#

JSON形式で指定する場合#

attributes.json#

[
    {
        "attribute_name_en": "comment",
        "attribute_name_ja": "コメント",
        "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
    }
]

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

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

キー	必須	説明
`attribute_id`	条件付き必須	更新対象属性の `attribute_id` 。 `attribute_name_en` とどちらか一方を指定してください。
`attribute_name_en`	条件付き必須	更新対象属性の英語名。 `attribute_id` とどちらか一方を指定してください。この値自体は更新されません。
`attribute_name_ja`	任意	更新後の属性日本語名。
`keybind`	任意	更新後のキーボードショートカットのJSONオブジェクト。 `code` に指定できる値は、 KeyboardEvent.code を参照してください。
`read_only`	任意	更新後の読み込み専用設定。 `true` または `false` を指定してください。
`default_value`	任意	更新後の初期値。属性の種類が `flag` の場合は真偽値、 `integer` の場合は整数、その他の場合は文字列を指定してください。

CSV形式で指定する場合#

attributes.csv#

attribute_id,attribute_name_en,attribute_name_ja,keybind,read_only,default_value
,comment,コメント,"{""alt"": false, ""code"": ""Digit1"", ""ctrl"": true, ""shift"": false}",false,確認済み
f12a0b59-dfce-4241-bb87-4b2c0259fc6f,,,,true,true

CSV形式では、 keybind 列だけはJSONオブジェクト文字列として指定してください。そのため、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 , keybind , read_only , default_value を指定できます。 (例) [{"attribute_name_en": "comment", "attribute_name_ja": "コメント", "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_csv: 更新する属性情報のCSVファイルを指定します。 CSVには attribute_id または attribute_name_en 列のどちらか一方が必要です。任意で attribute_name_ja , keybind , read_only , default_value 列を指定できます。 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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。