データローダWebAPI・テーブル一覧取得

定義済みデータローダおよびそのデータローダが使用するデータ投入テーブル（イベントデータ構造を含む）の一覧を表示します。

エンドポイント

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

リクエスト例

下記は本APIを用いてデータ投入テーブルの一覧を取得するリクエストになります。

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

レスポンス例

下記はひとつもテーブルを初期化していない状態で一覧取得した場合の返却内容になります。

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

下記はloaderwebapi.register_loaderリファレンス記載のリクエスト例で"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"
  }
}

パラメータ

なし

戻り値

正常終了時:

• data: データ投入テーブル情報のリスト
• data_name: loaderwebapi.register_loaderで初期化時に指定したdata_name
• record_def: loaderwebapi.register_loaderで初期化時に指定したrecord_def（デフォルト値で自動付与された属性情報を含む）
• data_num: データ投入テーブルの数
• message: 正常時"ok"、異常発生時"ng"

データベースアクセスに失敗した場合等、エラーが起きた場合は error を返します。