task update_metadata_per_task#

Description#

タスクごとに指定したメタデータを更新します。

Examples#

--json には、 task list --format json と同じ形式のJSON配列を指定します。各要素の task_id と metadata キーを参照し、それ以外のキーは無視します。メタデータの値には文字列、数値、真偽値を指定できます。

all_metadata.json#

[
  {"task_id": "task1", "metadata": {"priority": 1}},
  {"task_id": "task2", "metadata": {"priority": 2}}
]

$ annofabcli task update_metadata_per_task --project_id prj1 \
  --json file://all_metadata.json

デフォルトでは、JSONに指定したキーのみ更新されます。メタデータ全体を上書きするには --overwrite を指定してください。 --overwrite --yes を指定すると、通常より短時間で更新できます。詳細は task update_metadata を参照してください。

Usage Details#

タスクごとに指定したメタデータを更新します。

usage: annofabcli task update_metadata_per_task [-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 --json JSON
                                                [--overwrite]
                                                [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

--json

task list --format json と同じ形式のJSON配列を指定してください。各要素の task_id と metadata キーを参照し、それ以外のキーは無視します。メタデータの値には文字列、数値、真偽値のいずれかを指定できます。 (ex) '[{"task_id": "task1", "metadata": {"priority": 2}}]' file:// を先頭に付けると、JSON形式のファイルを指定できます。

--overwrite

指定した場合、メタデータを上書きして更新します（すでに設定されているメタデータは削除されます）。指定しない場合、JSONに指定されたキーのみ更新されます。 --yes と一緒に指定すると、処理時間は大幅に短くなります。

--parallelism

Possible choices: 2, 3, 4

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

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

オーナまたはアノテーションユーザロールを持つユーザで実行してください。