annotation change_properties#

Description#

アノテーションのプロパティを一括で変更します。ただし、作業中状態のタスクのアノテーションのプロパティは変更できません。

Examples#

基本的な使い方#

--properties に変更したいプロパティの名前と値をJSON形式で指定してください。変更可能なプロパティは以下の通りです。各プロパティの詳細は putAnnotation API のリクエストボディを参照してください。

is_protected ：trueの場合、アノテーションをアノテーションエディタ上での削除から保護できます。

$ annofabcli annotation change_properties --project_id prj1 --task_id task1 task2 \
--properties '{"is_protected":true}' \

変更対象のアノテーションを絞り込む場合は、--annotation_query を指定してください。 --annotation_query の詳細な使い方は、Command line options を参照してください。

$ annofabcli annotation change_properties --project_id prj1 --task_id task1 task2 \
--properties '{"is_protected":true}' \
--annotation_query '{"label": "car", "attributes":{"occluded": true}}'

デフォルトでは「担当者が自分自身でない AND 担当者が割り当てられたことがある」タスクは、アノテーションプロパティの変更をスキップします。 --force を指定すると、担当者を一時的に自分自身に変更して、アノテーションのプロパティを変更できます。

$ annofabcli annotation change_properties --project_id prj1 --task_id task1 task2 \
--properties '{"is_protected":true}' --force \

Usage Details#

アノテーションのプロパティを一括で変更します。ただし、作業中状態のタスクのアノテーションのプロパティは変更できません。間違えてアノテーションのプロパティを変更したときに復元できるようにするため、 --backup でバックアップ用のディレクトリを指定することを推奨します。

usage: annofabcli annotation change_properties [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--annofab_user_id ANNOFAB_USER_ID]
                                               [--annofab_password ANNOFAB_PASSWORD]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug] -p
                                               PROJECT_ID -t TASK_ID
                                               [TASK_ID ...]
                                               [-aq ANNOTATION_QUERY]
                                               --properties PROPERTIES
                                               [--force] [--backup BACKUP]
                                               [--parallelism PARALLELISM]

Named Arguments#

-p, --project_id: 対象のプロジェクトのproject_idを指定します。
-t, --task_id: 対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。
-aq, --annotation_query: 変更対象のアノテーションを検索する条件をJSON形式で指定します。(ex): {"label": "car", "attributes":{"occluded" true} }
--properties: 変更後のプロパティをJSON形式で指定します。変更可能なキーは is_protected です。file:// を先頭に付けると、JSON形式のファイルを指定できます。(ex): {"is_protected": true}
--force: 過去に割り当てられていて現在の担当者が自分自身でない場合、タスクの担当者を自分自身に変更してからアノテーションプロパティを変更します。
--backup: アノテーションのバックアップを保存するディレクトリを指定してください。アノテーションの復元は annotation restore コマンドで実現できます。
--parallelism: 並列度。指定しない場合は、逐次的に処理します。指定した場合は、--yes も指定してください。

global optional arguments#

--yes

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

--endpoint_url

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

Default: "https://annofab.com"

--annofab_user_id

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

--annofab_password

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

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