FileState
A file attached to a job, component, or other entity
Fields
Unique identifier
Associated job ID
Associated component ID
Associated order ID
Associated estimate ID
Associated invoice ID
Associated purchase order ID
Display name
Original filename as uploaded
MIME type of the file
File size in bytes, or null when the size is not known
Where the bytes live, or null while an upload is in flight
Possible values (2)
FOLDERFile bytes live in a tenant Folder (see FileState.folderId)
EXTERNALFile bytes live at an external path or URL the client supplied
Folder holding the bytes for folder-managed files; null otherwise
Storage key for external-backed files; null for folder-managed files
File checksum
File category
Possible values (11)
ARTWORKArtwork file
PREPRESSPrepress file
IMPOSITIONImposition file
PROOFProof file
PRODUCTION_OUTPUTProduction output file
QUALITY_REPORTQuality report file
INVOICEInvoice file
DELIVERY_NOTEDelivery note file
PURCHASE_ORDERPurchase order file
SUBSTRATESubstrate-related file
OTHEROther file category
Processing status
Possible values (5)
UPLOADINGFile is being uploaded
PROCESSINGFile is being processed
READYFile is ready for use
FAILEDFile processing failed
ARCHIVEDFile is archived
Usage role when attached to a component
Possible values (5)
ARTWORKArtwork usage
TEMPLATETemplate usage
DATAData usage
PATHPath usage
OTHEROther usage
Parent file ID for versioned files
Version number
Processing metadata (JSON)
ID of the user who uploaded the file
Creation timestamp (ISO8601)
Last update timestamp (ISO8601)
Referenced by (7)
Exact type SDL
"""A file attached to a job, component, or other entity"""
type FileState {
"""Unique identifier"""
id: FileID!
"""Associated job ID"""
jobId: JobID
"""Associated component ID"""
componentId: ComponentID
"""Associated order ID"""
orderId: OrderID
"""Associated estimate ID"""
estimateId: EstimateID
"""Associated invoice ID"""
invoiceId: InvoiceID
"""Associated purchase order ID"""
purchaseOrderId: PurchaseOrderID
"""Display name"""
name: String!
"""Original filename as uploaded"""
originalFilename: String!
"""MIME type of the file"""
mimeType: String!
"""File size in bytes, or null when the size is not known"""
sizeBytes: Int
"""Where the bytes live, or null while an upload is in flight"""
storageBackend: FileStorageBackendTag
"""Folder holding the bytes for folder-managed files; null otherwise"""
folderId: FolderID
"""Storage key for external-backed files; null for folder-managed files"""
externalStorageKey: String
"""File checksum"""
checksum: String
"""File category"""
category: FileCategory!
"""Processing status"""
status: FileStatus!
"""Usage role when attached to a component"""
usageRole: ComponentFileUsageRole
"""Parent file ID for versioned files"""
parentFileId: FileID
"""Version number"""
versionNumber: Int!
"""Processing metadata (JSON)"""
processingMetadata: JSONMap
"""ID of the user who uploaded the file"""
uploadedByUserId: UserID
"""Creation timestamp (ISO8601)"""
createdAt: String!
"""Last update timestamp (ISO8601)"""
updatedAt: String!
}