← All types

ComponentArtworkFileState

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

Fields

Unique identifier

Parent component ID

fileId

FileIDNullable

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)

Possible values (5)
ARTWORK

Artwork usage

TEMPLATE

Template usage

DATA

Data usage

PATH

Path usage

OTHER

Other usage

Human-readable description of this file's role

pageCount

IntNullable

Number of pages contributed by this file

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

sortOrder

Int!Non-null

Sort order within the component's artwork references

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

The referenced file record. Requires file:read permission.

Parent component. Requires component:read permission.

Referenced by (5)
Exact type 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
}