annotation change_editor_props#

Description#

指定したラベル名のアノテーションの editor_props （削除禁止などのプロパティ）を一括で変更します。 作業中状態のタスクに含まれるアノテーションは変更できません。

Examples#

基本的な使い方#

--task_id にアノテーション変更対象のタスクのtask_idを指定してください。

--label_name には、変更対象のアノテーションのラベル名（英語）を指定してください。 複数のラベル名を指定できます。

--editor_props に、変更後の editor_props をJSON形式で指定してください。 指定したキーだけ既存の editor_props にマージされます。

以下のコマンドは、ラベル名（英語）が car または road であるアノテーションに対して、 can_delete を false に変更します。

$ annofabcli annotation change_editor_props --project_id prj1 --task_id file://task.txt \
--label_name car road \
--editor_props '{"can_delete": false}' \
--backup backup_dir/

--backup にディレクトリを指定すると、変更対象の入力データに含まれるアノテーション情報を、バックアップとしてディレクトリに保存します。 アノテーション情報の復元は、 annofabcli annotation restore コマンドで実現できます。

注釈

間違えてアノテーションの editor_props を変更したときに復元できるようにするため、--backup を指定することを推奨します。

デフォルトでは完了状態のタスクに含まれるアノテーションは変更できません。完了状態のタスクに含まれるアノテーションも変更する場合は、 --include_complete_task を指定してください。 ただし、オーナーロールのユーザーで実行する必要があります。

デフォルトでは保留中状態のタスクに含まれるアノテーションも変更できません。保留中状態のタスクに含まれるアノテーションも変更する場合は、 --include_on_hold_task を指定してください。

editor_props に指定できるキー#

  • can_delete ：アノテーションを削除できるかどうか（2026年5月時点では、動画エディタでは対応していません）

  • can_edit_data ：アノテーションのデータを編集できるかどうか（2026年5月時点では、画像エディタ、動画エディタでは対応していません）

  • can_edit_additional ：アノテーションの属性値を編集できるかどうか（2026年5月時点では、画像エディタ、動画エディタでは対応していません）

Usage Details#

指定したラベル名のアノテーションに対して、editor_props（削除禁止などのプロパティ）を一括で変更します。ただし、作業中状態のタスクに含まれるアノテーションは変更できません。間違えてアノテーションのeditor_propsを変更したときに復元できるようにするため、 --backup でバックアップ用のディレクトリを指定することを推奨します。

usage: annofabcli annotation change_editor_props [-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 -t TASK_ID
                                                 [TASK_ID ...] --label_name
                                                 LABEL_NAME [LABEL_NAME ...]
                                                 --editor_props EDITOR_PROPS
                                                 [--change_operator_to_me]
                                                 [--include_complete_task]
                                                 [--include_on_hold_task]
                                                 [--backup BACKUP]
                                                 [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。

--label_name

変更対象のアノテーションのラベル名（英語）を指定します。複数指定できます。file:// を先頭に付けると、ラベル名が記載されたファイルを指定できます。

--editor_props

変更後のエディタ用プロパティをJSON形式で指定します。指定できるキーは can_delete, can_edit_data, can_edit_additional です。file:// を先頭に付けると、JSON形式のファイルを指定できます。(ex): {"can_delete": false, "can_edit_data": false, "can_edit_additional": false}

--change_operator_to_me

過去に割り当てられていて現在の担当者が自分自身でない場合、タスクの担当者を自分自身に変更してからアノテーションのeditor_propsを変更します。

--include_complete_task

完了状態のタスクに含まれるアノテーションのeditor_propsも変更します。ただし、オーナーロールを持つユーザーでしか実行できません。

--include_on_hold_task

保留中状態のタスクに含まれるアノテーションのeditor_propsも変更します。

--backup

アノテーションのバックアップを保存するディレクトリを指定してください。アノテーションの復元は annotation restore コマンドで実現できます。

--parallelism

Possible choices: 2, 3, 4

並列度。指定しない場合は、逐次的に処理します。指定した場合は、--yes も指定してください。

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

オーナロールを持つユーザで実行してください。

See also#