Record Files

RecordFiles entity

fileName

  

string

   

This is the unique name that the binary will have in the SideDrawer Database. It has to be unique. This is mandatory, and it can be set by the App. In order to do so, add the timestamp when EACH file is posted (YYMMDDHHMMSS_*), all timestamps for each file will be different.

---

envelopeId

  

string

   

Used as an ID to connect/combine different files that will be part of a sequence of signatures. The objective is to have the envelopeId to track all signatures and which one is the latest one that combines them all.

---

correlationId

  

string

   

This is the details of the upload instance. It is not mandatory.

---

uploadTitle

  

string

   

This is what should be listed in the "File History" list.

---

displayType

  

string

   

The front-end application will interpret (or ignore, in older versions) this parameter and display the file on screen using different versions of PDFTron. Based on that, the PDFTron widget will present the end user the ability to insert a signature, text fields, annotations, comments, or just preview the contents.

---

fileType

  

string

   

Enum that determines what kind of file is being pushed.

---

fileExtension

  

string

   

Original extension of the file being uploaded.

---

checkSum

  

string

   

Optional checksum calculated with the SHA256 algorithm. This guarantees integrity control over the uploaded file.

---