annotation_specs export

Description

アノテーション仕様の情報をJSON形式でエクスポートします。 このJSONは、アノテーション仕様のインポート機能 で利用できます。

Examples

基本的な使い方

$ annofabcli annotation_specs export --project_id prj1 --out out.json --format pretty_json

out.json

{
    "labels": [
        "label_id": "763e1659-94c8-4424-9fc8-11b8fbcb115f",
        "label_name": {...},
        ...
    ],
    "additionals": [...],
    ...
}

警告

annotation_specs export コマンドの出力結果は、アノテーション仕様のインポート機能で利用することを目的として作られています。

JSON構造は、将来変更される可能性があります。 annotation_specs export コマンドの出力結果であるJSONの構造に直接依存したプログラムを作成する場合は、ご注意ください。

Usage Details

アノテーション仕様の情報をエクスポートします。

usage: annofabcli annotation_specs export [-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
                                          [--history_id HISTORY_ID | --before BEFORE]
                                          [-o OUTPUT] [-f {json,pretty_json}]

Named Arguments

-p, --project_id

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

--history_id

出力したいアノテーション仕様のhistory_idを指定してください。 history_idは annotation_specs list_history コマンドで確認できます。 指定しない場合は、最新のアノテーション仕様が出力されます。

--before

出力したい過去のアノテーション仕様が、最新よりいくつ前のアノテーション仕様であるかを指定してください。 たとえば 1 を指定した場合、最新より1個前のアノテーション仕様を出力します。 指定しない場合は、最新のアノテーション仕様が出力されます。

-o, --output

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

-f, --format

Possible choices: json, pretty_json

出力フォーマット

Default: 'json'

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