The File Entity
catalytic.sdk.entities.instance
The File entity contains metadata about files uploaded to the Catalytic platform. Once uploaded, files can be deleted, but not modified.
Common Properties
These are the most commonly used properties of a File.
| Name | Return Type | Description |
|---|---|---|
getId | UUID | The unique ID of the File |
getName | String | The original name of the uploaded File |
getContentType | String | The content type of the File |
getSizeInBytes | Integer | The size of the File in bytes |
getDisplaySize | String | A human-readable version of the file size. E.g., 40 MB |
| 'getIsPublic` | Boolean | Indicates where the file can be downloaded without authentication |
getMd5Hash | String | The MD5 hash of the file's contents |
File Permissions
While files can be directly uploaded outside of a Workflow or Instance, it is more common for a file to be uploaded when starting an Instance or completing and Instance Step. When doing so, the file's permissions are inherited from the field permissions configured in the Workflow. If you are uploading a file directly, be sure the
Is Publicattribute is set toFalse(the default) unless you intend for the file to be anonymously downloadable via a link.
Updated over 3 years ago