Skip to content

FileState ​

Type: Object

A file attached to a job, component, or other entity

Fields ​

NameTypeArgsDescriptionDeprecated
categoryFileCategory!File category
checksumStringFile checksum
componentIdComponentIDAssociated component ID
createdAtString!Creation timestamp (ISO8601)
estimateIdEstimateIDAssociated estimate ID
externalStorageKeyStringStorage key for external-backed files; null for folder-managed files
folderIdFolderIDFolder holding the bytes for folder-managed files; null otherwise
idFileID!Unique identifier
invoiceIdInvoiceIDAssociated invoice ID
jobIdJobIDAssociated job ID
mimeTypeString!MIME type of the file
nameString!Display name
orderIdOrderIDAssociated order ID
originalFilenameString!Original filename as uploaded
parentFileIdFileIDParent file ID for versioned files
processingMetadataJSONMapProcessing metadata (JSON)
purchaseOrderIdPurchaseOrderIDAssociated purchase order ID
sizeBytesInt!File size in bytes
statusFileStatus!Processing status
storageBackendFileStorageBackendTagWhere the bytes live, or null while an upload is in flight
updatedAtString!Last update timestamp (ISO8601)
uploadedByUserIdUserIDID of the user who uploaded the file
usageRoleComponentFileUsageRoleUsage role when attached to a component
versionNumberInt!Version number

Connect machines, automate workflows, and build custom apps for print production.