Skip to content

Get list of data loader WebAPI and tables

Note

This document has been machine translated.

Displays a list of predefined data loaders and the data submission tables (including event data structures) used by those data loaders.

Endpoint

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

Request Example

The following is a request to obtain a list of data input tables using this API.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "loaderwebapi.get_loader_list",
  "params": {}
}

Response Example

The following is an example of a list acquisition without initializing any tables.

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "data": [],
    "data_num": 0,
    "message": "ok"
  }
}

The following is an example request from loaderwebapi.register_loader reference, where the table is initialized with the parameter “data_name=test_event_001”. The above is what is returned when the list is acquired using the above request after initializing the table with the parameter “data_name=test_event_001”.

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "data": [
      {
        "data_name": "test_event_001",
        "record_def": {
          "end_datetime": {
            "column_default": null,
            "data_type": "timestamp with time zone",
            "is_nullable": "YES",
            "position": 2,
            "udt_name": "timestamptz"
          },
          "location": {
            "column_default": null,
            "data_type": "USER-DEFINED",
            "is_nullable": "YES",
            "position": 3,
            "udt_name": "geometry"
          },
          "start_datetime": {
            "column_default": null,
            "data_type": "timestamp with time zone",
            "is_nullable": "YES",
            "position": 1,
            "udt_name": "timestamptz"
          },
          "test_varchar_1": {
            "column_default": "\'\'::character varying",
            "data_type": "character varying",
            "is_nullable": "NO",
            "position": 4,
            "udt_name": "varchar"
          }
        },
        "table_name": "event.test_event_001_tbl_0",
        "unique_columns": ["location","start_datetime"]
      }
    ],
    "data_num": 1,
    "message": "ok"
  }
}

Parameters

None

Return value

On successful completion: data: list of data input table information

  • data: list of data input table information
  • data_name: data_name specified at initialization in loaderwebapi.register_loader
  • record_def: record_def specified at initialization with loaderwebapi.register_loader (including attribute information automatically assigned with default values)
  • data_num: number of tables to populate
  • message: “ok” in case of success, “ng” in case of failure.

If an error occurs, such as database access failure, error is returned.