task delete#

Description#

タスクを削除します。

ただしタスクのステータスが「作業中」または「完了」の場合は、タスクを削除できません。

Examples#

基本的な使い方#

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

task_id.txt#
task1
task2
...

$ annofabcli task delete --project_id prj1 --task_id file://task_id.txt

デフォルトでは、アノテーションが付与されているタスクは削除できません。 アノテーションが付与されているタスクを削除する場合は --delete_annotated_task を指定してください。

$ annofabcli task delete --project_id prj1 --task_id file://task_id.txt --delete_annotated_task

--delete_input_data を指定すれば、タスクが参照している入力データとそれに紐づく補助情報も削除されます。ただし、他のタスクから参照されている入力データは、削除されません。

$ annofabcli task delete --project_id prj1 --task_id file://task_id.txt --delete_input_data

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

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

以下のコマンドは task_id.txt に記載されているタスクの内、教師付フェーズで未着手のタスクを削除します。

$ annofabcli task delete --project_id prj1 --task_id file://task_id.txt \
 --task_query '{"phase":"annotation", "status:"not_started"}'

Usage Details#

タスクを削除します。ただし、作業中/完了状態のタスクは削除できません。デフォルトは、アノテーションが付与されているタスクは削除できません。

usage: annofabcli task delete [-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 ...] [--delete_annotated_task]
                              [--delete_input_data] [--dryrun]
                              [-tq TASK_QUERY]

Named Arguments#

-p, --project_id

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

-t, --task_id

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

--delete_annotated_task

アノテーションが付与されているタスクも削除します。

--delete_input_data

指定した場合、タスクから参照されている入力データと、その入力データに紐づく補助情報を削除します。ただし、他のタスクから参照されている入力データは削除しません。

--dryrun

削除が行われた時の結果を表示しますが、実際はタスクを削除しません。

-tq, --task_query

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

  • task_id

  • phase

  • phase_stage

  • status

  • user_id

  • account_id

  • no_user

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

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