API Reference
Log In
API Reference

Files

Files (recordFile) are the actual files created in or uploaded to a Drawer (sidedrawer), Hanger (recordType), and Folder (record).

Once a file has been added to a Folder, this file is accessible via API call by the sidedrawerId of the Drawer to which it belongs, the recordId of the Folder to which it belongs, and the file's fileNameWithExtension or fileToken.

More info about the organization of entities here.


Uploading Files with SideDrawer

We have two main methods of uploading files in SideDrawer:

  1. File upload – a typical binary hosted in an AWS S3 bucket or Azure Blob
  2. Blocks upload – chunks of binary up to 4 MB hosted in an AWS S3 bucket or Azure Blob:
    • Split into chunks or "Blocks" for efficiency
    • Require API & SDK to reassemble the file at time of download

To learn more about using Blocks to upload files, see our guide.


{
  "id": "{fileId}",
  "fileName": "My File",
  "correlationId": "{correlationId}",
  "uploadDetail": "",
  "caption": "My File",
  "uploader": "Jane Smith",
  "url": "",
  "fileTypeEnum": "document"
}

File (recordFile) entity

id string required
Unique file identifier.

fileName string required
File name.

correlationId string required
A uniquely defined parameter that allows the API to "group" all files uploaded as part of the same process. This field is mandatory for all uploads and it has to be unique enough for the drawer/folder (sidedrawer)/(record) at the least. Our recommendation is to use the timestamp (YYMMDDHHMMSS) of the instant in which you "submit" the upload of the file.

uploadDetail string required
Details of the upload instance.

caption string
File caption.

uploader string required
Uploader's name.

url string required
URL of the file to download.

fileTypeEnum enum required
File type.
Possible values: image, document, cloud.