comment list_all_with_replies#

Description#

すべてのルートコメントに返信コメント一覧を付与して出力します。

注釈

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

Examples#

基本的な使い方#

以下のコマンドを実行すると、すべてのルートコメントに reply_comments として返信コメント一覧を付与したJSONが出力されます。

$ annofabcli comment list_all_with_replies --project_id prj1 --format pretty_json

--comment_type を指定すると、コメントの種類で絞り込めます。

$ annofabcli comment list_all_with_replies --project_id prj1 \
 --comment_type inspection --format pretty_json

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

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

$ annofabcli comment list_all_with_replies --project_id prj1 \
 --comment_json comment.json --format pretty_json

出力結果#

annofabcli comment list_all コマンドで出力されるルートコメントの構造に、返信コメント一覧の reply_comments が追加されます。 reply_comments 配下の返信コメントには reply_count は含まれません。

[
  {
    "project_id": "project1",
    "task_id": "task1",
    "input_data_id": "input_data1",
    "comment_id": "root-comment1",
    "comment": "枠がずれています",
    "comment_node": {
      "status": "open",
      "_type": "Root"
    },
    "reply_count": 1,
    "reply_comments": [
      {
        "project_id": "project1",
        "task_id": "task1",
        "input_data_id": "input_data1",
        "comment_id": "reply-comment1",
        "comment": "修正しました",
        "comment_node": {
          "root_comment_id": "root-comment1",
          "_type": "Reply"
        }
      }
    ]
  }
]

Usage Details#

すべてのルートコメントに返信コメント一覧を付与して出力します。コメント一覧は、コマンドを実行した日の02:00(JST)頃の状態です。最新のコメント情報を取得したい場合は、 annofabcli comment list_with_replies コマンドを実行してください。

usage: annofabcli comment list_all_with_replies [-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 ...]]
                                                [--comment_type {inspection,onhold}]
                                                [--comment_json COMMENT_JSON]
                                                [--temp_dir TEMP_DIR]
                                                [-f {json,pretty_json}]
                                                [-o OUTPUT]

Named Arguments#

-p, --project_id

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

-t, --task_id

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

--comment_type

Possible choices: inspection, onhold

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

inspection: 検査コメント

onhold: 保留コメント

--comment_json

コメント情報が記載されたJSONファイルのパスを指定すると、JSONに記載された情報を元にコメント一覧を出力します。 JSONファイルは $ annofabcli comment download コマンドで取得できます。

--temp_dir

--comment_json を指定しなかった場合、ダウンロードしたJSONファイルの保存先ディレクトリを指定できます。指定しない場合は、一時ディレクトリに保存されます。

-f, --format

Possible choices: json, pretty_json

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

Default: 'json'

-o, --output

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

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