comment download

Description

コメント全件ファイルをダウンロードします。

Examples

基本的な使い方

以下のコマンドを実行すると、コメント全件ファイルがダウンロードされます。

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

作成したコメントは、02:00(JST)頃にコメント全件ファイルに反映されます。

出力結果

$ annofabcli comment download --output out.json
$ jq . out.json > out-pretty.json

out-pretty.json

[
{
    "project_id": "project1",
    "task_id": "task1",
    "input_data_id": "input_data1",
    "comment_id": "comment1",
    "phase": "acceptance",
    "phase_stage": 1,
    "account_id": "account1",
    "comment_type": "onhold",
    "phrases": [],
    "comment": "画像が間違っている",
    "comment_node": {
    "data": null,
    "annotation_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
    "label_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
    "status": "open",
    "_type": "Root"
    },
    "datetime_for_sorting": "2022-07-05T11:45:21.968+09:00",
    "created_datetime": "2022-07-05T11:45:32.88+09:00",
    "updated_datetime": "2022-07-05T11:45:32.88+09:00"
},
{
    "project_id": "project1",
    "task_id": "task1",
    "input_data_id": "input_data1",
    "comment_id": "comment2",
    "phase": "acceptance",
    "phase_stage": 1,
    "account_id": "account2",
    "comment_type": "inspection",
    "phrases": [],
    "comment": "枠がずれています",
    "comment_node": {
    "data": {
        "x": 62,
        "y": 137,
        "_type": "Point"
    },
    "annotation_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
    "label_id": "8ec9417b-abef-47ad-af7d-e0a03c680eac",
    "status": "open",
    "_type": "Root"
    },
    "datetime_for_sorting": "2022-07-05T11:45:08.506+09:00",
    "created_datetime": "2022-07-05T11:45:32.88+09:00",
    "updated_datetime": "2022-07-05T11:45:32.88+09:00"
}
]

Usage Details

コメント全件ファイルをダウンロードします。

usage: annofabcli comment download [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                   [--annofab_user_id ANNOFAB_USER_ID]
                                   [--annofab_password ANNOFAB_PASSWORD]
                                   [--logdir LOGDIR] [--disable_log] [--debug]
                                   -p PROJECT_ID -o OUTPUT

Named Arguments

-p, --project_id

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

-o, --output

ダウンロード先を指定します。

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

オーナロールまたはアノテーションユーザロールを持つユーザで実行してください。