Skip to content

Delete data loader WebAPI and tables

Note

This document has been machine translated.

Deletes the target data loader and the data submission tables used by the data loader. Note that all data added by loaderwebapi.addrecord will be deleted.

Endpoint

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

Example request

The following is a request to delete the data input table created when the table was initialized with the parameter “data_name=test_event_001” in loaderwebapi.register_loader The request is to delete the table.

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

Response Example

The following is the content returned if the deletion is successful based on the above request.

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

Parameters

JSON-RPC request contents that can be specified in “params” are shown below. Parameters marked with Required are required.

Return values

On successful completion: `deleted_data

  • deleted_data: Information on deleted tables
  • data_name: data_name of the deleted table. This is specified as a parameter when the table is initialized by loaderwebapi.register_loader.
  • table_name: The name of the deleted real table. The table was created when the table was initialized with loaderwebapi.register_loader.
  • message: “ok” when normal, “ng” when an error occurs.

Return error in case of errors, such as failed table deletion.