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. Validated by a range rule: must be greater than zero.
description	string	Yes	The description of the file. Must be 1000 or fewer characters in length.
createdAtUtc	DateTime	No	The DateTime that the file was created at.
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 event the file is associated with. If specified, must be greater than zero.
fileKey	string	No	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	List[fileMetadata]	No	An optional list of fileMetadata. If present, the file metadata will be created and associated with the file.

Attribute	Type	Description
url	string	The presigned S3 URL to upload the file to. Valid for one hour.
expiry	DateTime	The UTC date and time the URL expires.
requiredFileName	string	The file must be renamed to this value before uploading, or the upload will fail.

Below is a table mapping the file status value to its 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.
7	Upload requested. The file has been flagged for upload but has not yet begun uploading.