supplementary delete#
Description#
補助情報を削除します。
Examples#
基本的な使い方#
補助情報を指定して削除する(CSV)#
--csv
に、削除する補助情報が記載されたCSVファイルのパスを指定してください。
CSVのフォーマットは以下の通りです。
カンマ区切り
ヘッダ行なし
列番号 |
名前 |
必須 |
備考 |
---|---|---|---|
1列目 |
input_data_id |
Yes |
|
2列目 |
supplementary_data_id |
Yes |
以下はCSVファイルのサンプルです。
input1,supplementary1
input1,supplementary2
input2,supplementary3
$ annofabcli supplementary delete --project_id prj1 --csv supplementary_data.csv
補助情報を指定して削除する(JSON)#
JSON形式で指定された補助情報を削除します。
以下は、JSONのサンプルです。
[
{
"input_data_id": "input1",
"supplementary_data_id": "supplementary1",
},
{
"input_data_id": "input2",
"supplementary_data_id": "supplementary2",
},
]
JSONのキーは、 --csv
に指定するCSVファイルの列に対応します。
--json
にJSON形式の文字列、またはJSONファイルのパスを指定できます。
$ annofabcli supplementary delete --project_id prj1 --json file://input_data.json
入力データに紐づく全ての補助情報を削除する#
--input_data_id
に入力データのinput_data_idを指定すると、入力データに紐づく全ての補助情報を削除します。
$ annofabcli supplementary delete --project_id prj1 --input_data_id input1 input2
Usage Details#
補助情報を削除します。
usage: annofabcli supplementary delete [-h] [--yes]
[--endpoint_url ENDPOINT_URL]
[--annofab_user_id ANNOFAB_USER_ID]
[--annofab_password ANNOFAB_PASSWORD]
[--logdir LOGDIR] [--disable_log]
[--debug] -p PROJECT_ID
(--csv CSV | --json JSON | -i INPUT_DATA_ID [INPUT_DATA_ID ...])
Named Arguments#
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- --csv
削除する補助情報が記載されたCSVファイルのパスを指定してください。 CSVのフォーマットは以下の通りです。詳細は https://annofab-cli.readthedocs.io/ja/latest/command_reference/supplementary/delete.html を参照してください。
ヘッダ行なし, カンマ区切り
1列目: input_data_id (required)
2列目: supplementary_data_id (required)
- --json
削除対象の補助情報データをJSON形式で指定してください。 JSONの各キーは
--csv
に渡すCSVの各列に対応しています。file://
を先頭に付けるとjsonファイルを指定できます。 (ex)[{"input_data_id" : "input1", "supplementary_data_id" : "supplementary1"}]
- -i, --input_data_id
削除する補助情報に紐づく入力データのinput_data_idを指定してください。指定した入力データに紐づくすべての補助情報を削除します。
file://
を先頭に付けると、input_data_idの一覧が記載されたファイルを指定できます。
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リクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。
オーナロールを持つユーザで実行してください。