← API reference
CANONICAL TYPE REFERENCE

CreateFileInput

Input for creating an external-backed file. Cloud-backed files go through requestFileUploads / completeFileUploads.

Associated job ID

Associated component ID

Associated order ID

Associated estimate ID

Associated invoice ID

Associated purchase order ID

nameString!

Display name (required)

Original filename (required)

mimeTypeString!

MIME type (required)

File size in bytes (required)

Storage key for external-backed files (required). Cloud uploads use requestFileUploads.

checksumString

File checksum

File category (required)

Processing status (defaults to ready)

Usage role when attached to a component

Parent file ID for versioned files

Version number (defaults to 1)

Processing metadata (JSON)

ID of the user uploading the file

View exact SDL
"""
Input for creating an external-backed file. Cloud-backed files go through requestFileUploads / completeFileUploads.
"""
input CreateFileInput {
  """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 (required)"""
  name: String!
  """Original filename (required)"""
  originalFilename: String!
  """MIME type (required)"""
  mimeType: String!
  """File size in bytes (required)"""
  sizeBytes: Int!
  """
  Storage key for external-backed files (required). Cloud uploads use requestFileUploads.
  """
  externalStorageKey: String!
  """File checksum"""
  checksum: String
  """File category (required)"""
  category: FileCategory!
  """Processing status (defaults to ready)"""
  status: FileStatus
  """Usage role when attached to a component"""
  usageRole: ComponentFileUsageRole
  """Parent file ID for versioned files"""
  parentFileId: FileID
  """Version number (defaults to 1)"""
  versionNumber: Int
  """Processing metadata (JSON)"""
  processingMetadata: JSONMap
  """ID of the user uploading the file"""
  uploadedByUserId: UserID
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.