annotation restore#

Description#

アノテーション情報をリストアします。 ただし、作業中または完了状態のタスクに対してはアノテーション情報をリストアできません。

Examples#

基本的な使い方#

--annotation に、以下のいずれかのディレクトリパスを指定してください。

$ annofabcli annotation dump --project_id prj1 --task_id file://task.txt --output_dir backup-dir/

$ annofabcli annotation restore --project_id prj1 --annotation backup-dir/

リストア対象のタスクを指定する場合は、--task_id にリストア対象のタスクのtask_idを指定してください。

$ annofabcli annotation restore --project_id prj1 --annotation backup-dir/ \
--task_id t1 t2

デフォルトでは以下のタスクに対しては、アノテーションのリストアをスキップします。

  • タスクの担当者が自分自身でない

  • タスクに担当者が割れ当てられたことがある

--change_operator_to_me を指定すると、担当者を一時的に自分自身に変更して、アノテーションをリストアすることができます。

$ annofabcli annotation restore --project_id prj1 --annotation backup-dir/ \
--change_operator_to_me

Usage Details#

'annotation dump'コマンドの出力結果から、アノテーション情報をリストアします。ただし、作業中/完了状態のタスクはリストアできません。

usage: annofabcli annotation restore [-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 --annotation
                                     ANNOTATION [-t TASK_ID [TASK_ID ...]]
                                     [--change_operator_to_me]
                                     [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

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

--annotation

'annotation dump'コマンドの保存先ディレクトリのパスを指定してください。

-t, --task_id

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

--change_operator_to_me

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

--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#