File Handling

In order to use the file management utilities provided by the FIMMAS Data Services API, a file server must be accessible to both the FIMMAS and API servers.

File names and locations are linked in FIMMAS, and should not be moved, renamed or deleted directly from the file system. Instead, files should be managed through the proper FIMMAS interfaces.

Download

File downloads through the FIMMAS Data Services API are returned using the DATA.FILE property of the standard JSON response structure. The FILE object has three properties:

Name Data Type Description
DATA String The file’s contents, as a base64-encoded string
NAME String The file’s name, including the file extension
TYPE String The file extension by itself 
{
  "DATA": [],
  "EXCEPTIONS": [],
  "RESPONSE": 200,
  "UUID": "450b5f90-c94d-4991-b452-7a46f0a31f42",
  "SEQ": 1,
  "TOTPAGES": 2,
  "FILE": {
    "DATA": "<base64 encoded file contents>",
    "NAME": "example.doc",
    "TYPE": "doc"
  }
}

Upload

At the time of the HTTP request, the FIMMAS Data Services API assumes that The file has already been validated against reserved filenames, size limitations and any other security measures you wish to implement. Files are passed to the API as base64 encoded strings inside of the JSON request body.