Model Definitions
File Definition
| Name | Type | Required | Meaning |
|---|---|---|---|
| id | int | For Updates | A unique identifying integer. |
| organizationId | int | Yes | The ID of the organization the file belongs to. Must be greater than zero. |
| description | string | No | The description of the file. Must be 1000 or fewer characters in length. |
| createdAtUtc | DateTime | Yes | The DateTime that the file was created at. Must not be in the future. |
| downloadLink | string | No | A presigned URL to download the file from S3. The link is good for 24 hours. |
| machineId | int? | No | The ID of the machine that generated the even the file is associated with. If specified, must be greater than zero. |
| fileKey | string | Yes | The file name. Must be 1000 or fewer characters in length. |
| status | int | Yes | An integer indicating the file's status. See file status for more information. |
| fileMetadata | fileMetadata | No | An optional fileMetadata. If present, the file metadata will be created and associated with the file. |
File Status Definition
Below is a table mapping the file status value to it's definition.
| Value | Definition |
|---|---|
| 1 | The file has been created. |
| 2 | The file is at available at the machine but has not yet been set to upload. |
| 3 | The file is pending upload. Usually results from the machine having a spool of files to be uploaded. |
| 4 | The file is currently uploading. |
| 5 | The file has been uploaded and is available to download. |
| 6 | Expired. |