← API reference
CANONICAL TYPE REFERENCE

ComponentArtworkFileState

A reference linking a component to an artwork file (or external URI) it uses

Unique identifier

Parent component ID

Referenced file ID (nil when using externalUri)

External URI for artwork not tracked in the file store

Role this file plays for the component (artwork / template / data / path / other)

Human-readable description of this file's role

Number of pages contributed by this file

pageRangeString

Page range within the file to use (e.g. '1-32' or 'all')

Sort order within the component's artwork references

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

The referenced file record. Requires file:read permission.

Parent component. Requires component:read permission.

View exact SDL
"""
A reference linking a component to an artwork file (or external URI) it uses
"""
type ComponentArtworkFileState {
  """Unique identifier"""
  id: ComponentArtworkFileID!
  """Parent component ID"""
  componentId: ComponentID!
  """Referenced file ID (nil when using externalUri)"""
  fileId: FileID
  """External URI for artwork not tracked in the file store"""
  externalUri: String
  """
  Role this file plays for the component (artwork / template / data / path / other)
  """
  usageRole: ComponentFileUsageRole!
  """Human-readable description of this file's role"""
  description: String
  """Number of pages contributed by this file"""
  pageCount: Int
  """Page range within the file to use (e.g. '1-32' or 'all')"""
  pageRange: String
  """Sort order within the component's artwork references"""
  sortOrder: Int!
  """Creation timestamp (ISO8601)"""
  createdAt: String!
  """Last update timestamp (ISO8601)"""
  updatedAt: String!
  """The referenced file record. Requires file:read permission."""
  file: FileState
  """Parent component. Requires component:read permission."""
  component: ComponentState
}

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