task change_status_to_on_hold#

Description#

タスクのステータスを保留中に変更します。

ワーカーロールで実行する場合#

ワーカーロールで実行する場合は、自身が担当するタスクだけを操作できます。自身が担当していないタスクはスキップします。

Examples#

基本的な使い方#

--task_id に操作対象タスクのtask_idを指定してください。

task_id.txt#
task1
task2
...

以下のコマンドは、タスク t1 のステータスを保留中に変更します。 ただし、操作対象のタスクのステータスは休憩中または未着手である必要があります。

$ annofabcli task change_status_to_on_hold --project_id prj1 --task_id t1

保留コメントの付与#

--comment に指定した内容が保留コメントとして付与されます。保留コメントは先頭の入力データに付与されます

$ annofabcli task change_status_to_on_hold --project_id prj1 --task_id t1 \
 --comment 画像が壊れているため作業できません

タスクのフェーズやステータスなどで絞り込み#

--task_query を指定すると、タスクのフェーズやステータスなどで、操作対象のタスクを絞り込むことができます。

以下のコマンドは、task_id.txt に記載されているタスクの内、受入フェーズのタスクに対してステータスを休憩中または未着手から保留中に変更します。

$ annofabcli task change_status_to_on_hold --project_id prj1 --task_id file://task_id.txt \
 --task_query '{"phase":"acceptance"}'

並列処理#

以下のコマンドは、並列数4で実行します。

$  annofabcli task change_status_to_on_hold --project_id prj1 --task_id file://task.txt \
--parallelism 4 --yes

Usage Details#

タスクのステータスを保留に変更します。ただし、操作対象のタスクのステータスは休憩中か未着手である必要があります。

usage: annofabcli task change_status_to_on_hold [-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 ...] [-tq TASK_QUERY]
                                                [--comment COMMENT]
                                                [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定するIDや別のファイル指定とは併用できません。

-tq, --task_query

タスクを絞り込むためのクエリ条件をJSON形式で指定します。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 以下のキーを指定できます。

  • task_id

  • phase

  • phase_stage

  • status

  • user_id

  • account_id

  • no_user

--comment

保留コメントを指定してください。保留コメントは先頭の入力データに付与します。

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

アノテータ、チェッカーまたはオーナロールを持つユーザで実行してください。ワーカーロールで実行する場合は、自身が担当するタスクだけを操作できます。