データローダWebAPI・テーブル削除

対象のデータローダおよびそのデータローダが使用するデータ投入テーブルを削除します。loaderwebapi.addrecordで追加されたデータがすべて削除されますのでご注意ください。

エンドポイント

https://<api-server-endpoint>/api/v1/dataloaderapi/jsonrpc

リクエスト例

下記はloaderwebapi.register_loaderで"data_name=test_event_001"というパラメータでテーブル初期化したときに作成されたデータ投入テーブルを削除するリクエストになります。

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "loaderwebapi.delete_loader",
  "params": {
    "data_name": "test_event_001"
  }
}

レスポンス例

下記は上記のリクエスト内容で削除に成功した場合の返却内容になります。

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "deleted_data": {
      "data_name": "test_event_001",
      "table_name": "event.test_event_001_tbl_0"
    },
    "message": "ok"
  }
}

パラメータ

JSON-RPCリクエスト内容のうち、params 内に指定可能なものを下記に表示します。 Required と書かれたものは必須パラメータです。

• data_name: string (Required)
  • 削除したいテーブルを指し示す名前。loaderwebapi.register_loaderで指定したものを使う。

戻り値

正常終了時:

• deleted_data: 削除したテーブルの情報
• data_name: 削除したテーブルのdata_name。loaderwebapi.register_loaderでテーブルを初期化した時にパラメータで指定したもの。
• table_name: 削除した実テーブル名。テーブルはloaderwebapi.register_loaderでテーブルを初期化した時に生成されたもの。
• message: 正常時"ok"、異常発生時"ng"

テーブル削除に失敗した場合等、エラーが起きた場合は error を返します。