Skip to content

File Acquisition API - getfileapi.get_file

Note

This document has been machine translated.

Returns the information of the file in Event data saved by Data Loader WebAPI. jpeg and tiff formats are returned with latitude and longitude embedded as EXIF information.

Endpoint

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

Example request

The following is a request for the case where data_name is defined as test_event_001 in [loaderwebapi.add_record]. 

{
  "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"
  }
}

Response Example

The following is the return content for the above request.

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

Parameters

JSON-RPC request contents that can be specified in params are displayed below. All parameters are required.

  • data_name: string specified in loaderwebapi.register_loader
  • prefix_id: The value of the column name defined in file_prefixid_column when register_loader, fixed to 1.
  • path_id: In register_loader, the value of column name defined in file_pathid_column.
  • file_name: In register_loader, the value of the column name defined in file_name_column.

Return values

file_data: returned as a base64-ized string, embedded in the form of EXIF if the file is a jpeg or tiff file and has space-time information.