comment list_all

Description

すべてのコメント一覧を出力します。

注釈

コメント一覧は、コマンドを実行した日の02:00(JST)頃の状態です。 最新のコメント情報を取得したい場合は、 annofabcli comment list コマンドを実行してください。

Examples

基本的な使い方

以下のコマンドを実行すると、すべてのコメント(検査コメントまたは保留コメント)の一覧が出力されます。

$ annofabcli comment list_all --project_id prj1

annofabcli comment download コマンドの出力結果であるコメント全件ファイルも指定することができます。

$ annofabcli comment download --project_id prj1 --output comment.json

$ annofabcli comment list_all --project_id prj1 --comment_json comment.json

出力結果

annofabcli comment list コマンドの出力結果と同じです。

Usage Details

コメント一覧を出力します。

usage: annofabcli comment list [-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 ...]
                               [--comment_type {inspection,onhold}]
                               [--exclude_reply]
                               [-f {csv,json,pretty_json,comment_id_list}]
                               [-o OUTPUT] [--csv_format CSV_FORMAT]

Named Arguments

-p, --project_id

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

-t, --task_id

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

--comment_type

Possible choices: inspection, onhold

コメントの種類で絞り込みます。

  • inspection: 検査コメント

  • onhold: 保留コメント

--exclude_reply

返信コメントを除外します。

-f, --format

Possible choices: csv, json, pretty_json, comment_id_list

出力フォーマットを指定します。

Default: "csv"

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

--csv_format

CSVのフォーマットをJSON形式で指定します。 --formatcsv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。 指定した値は pandas.DataFrame.to_csv の引数として渡されます。

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