Skip to content

ファイル取得API

データローダWebAPIで保存したイベントデータ内のファイルの情報を返却します。jpeg及びtiff形式の場合、EXIF情報として緯度・経度を埋め込んで返却します。

エンドポイント

https://pf.xdata.nict.jp/api/v1/getfileapi/jsonrpc

リクエスト例

下記は [loaderwebapi.add_record] で test_event_001 という名前で data_nameを定義した場合のリクエストになります。

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "getfileapi.get_file",
  "params": {
    "data_name": "test_event_001",
    "prefix_id": 1,
    "path_id": "your_path_id",
    "file_name": "your_file_name.jpg"
  }
}

レスポンス例

下記は上記のリクエスト内容での返却内容になります。

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "file_data": "/9j/..."
  }
}

パラメータ

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

  • data_name: loaderwebapi.register_loader で指定した文字列
  • prefix_id: register_loader 時、file_prefixid_column で定義したカラム名の値で、1固定。
  • path_id: register_loader 時、file_pathid_column で定義したカラム名の値
  • file_name: register_loader 時、file_name_column で定義したカラム名の値

戻り値

file_data: base64化された文字列で返却し、jpegまたはtiffファイルで時空間情報があればEXIFの形で埋め込まれた状態となる。