データ削除API
指定されたパラメーターでデータを削除する。
メソッド
POST
パス
/masters/delete/{object_id}
| Name | 型 | 概要 |
|---|---|---|
object_id(必須) | 文字列 | オブジェクトID |
リクエストボディ
| Name | 型 | 概要 |
|---|---|---|
tenant_id(必須) | 文字列 | テナントID ※別途お渡しした内容をご利用ください。 |
contents.search_condition.{field_name} | 文字列 | 検索条件{field_name}には削除するデータの項目名を指定します。※指定可能な条件については検索条件を参照ください。 |
contents.safety_flg | 文字列 | 安全モードフラグ'1'を指定してください。 |
contents.all_delete_flg | 文字列 | 全件削除フラグ'1'の場合、全件削除を行います。その場合、検索条件は無視されます。デフォルトは '0'です(検索条件により削除されます)。 |
レスポンスボディ
| Name | 型 | 概要 |
|---|---|---|
status(必須) | 文字列 | ステータスコード |
message(必須) | 文字列 | 実行メッセージ |
contents.detail_message | 文字列、配列 | エラーメッセージ |
contents.mst_delete_cnt | 数値 | 削除件数 ※正常時のみ付加 |
レスポンスの例
{
"status": "1001",
"message": "正常終了",
"contents": {
"mst_delete_cnt": 1
}
}