← API reference
CANONICAL TYPE REFERENCE

ComponentState

A component within a job

Unique identifier

Parent job ID

Parent component group ID (nil for ungrouped components)

Internal component number

External system ID

nameString!

Component name

Component description

Component classification

Number of units

Sort order within the job

Creation timestamp (ISO8601)

Last update timestamp (ISO8601)

Parent job. Requires job:read permission.

Parent component group. Requires componentGroup:read permission.

Operations for this component. Requires operation:list permission.

Component-scoped milestones (does not include job-wide milestones). Requires milestone:list permission.

Total number of pages

Color specification for front and back

Layout specification with layers

Media/paper specification

Finished size after trimming

Finishing specification (varnish, die, foil, emboss)

Desired substrate/paper ID

Actual substrate/paper ID

Artwork files attached to this component

Imposition specifications for this component

Prepress operations for this component

Preflight reports for this component

Desired substrate/paper for this component

Actual substrate/paper used for this component

View exact SDL
"""A component within a job"""
type ComponentState {
  """Unique identifier"""
  id: ComponentID!
  """Parent job ID"""
  jobId: JobID!
  """Parent component group ID (nil for ungrouped components)"""
  componentGroupId: ComponentGroupID
  """Internal component number"""
  componentNumber: String
  """External system ID"""
  externalId: String
  """Component name"""
  name: String!
  """Component description"""
  description: String
  """Component classification"""
  kind: ComponentKind!
  """Number of units"""
  quantity: Int!
  """Sort order within the job"""
  sortOrder: Int!
  """Creation timestamp (ISO8601)"""
  createdAt: ISO8601!
  """Last update timestamp (ISO8601)"""
  updatedAt: ISO8601!
  """Parent job. Requires job:read permission."""
  job: JobState
  """Parent component group. Requires componentGroup:read permission."""
  componentGroup: ComponentGroupState
  """Operations for this component. Requires operation:list permission."""
  operations: [OperationState!]!
  """
  Component-scoped milestones (does not include job-wide milestones). Requires milestone:list permission.
  """
  milestones: [MilestoneState!]!
  """Total number of pages"""
  totalPages: Int
  """Color specification for front and back"""
  colors: ComponentColorInfo
  """Layout specification with layers"""
  layout: ComponentLayout
  """Media/paper specification"""
  media: Media
  """Finished size after trimming"""
  finishedSize: Media
  """Finishing specification (varnish, die, foil, emboss)"""
  finishing: FinishingSpec
  """Desired substrate/paper ID"""
  desiredSubstrateId: SubstrateID
  """Actual substrate/paper ID"""
  actualSubstrateId: SubstrateID
  """Artwork files attached to this component"""
  artworkFiles: [ComponentArtworkFileState!]!
  """Imposition specifications for this component"""
  impositionSpecs: [ImpositionSpecState!]!
  """Prepress operations for this component"""
  prepressOperations: [PrepressOperationState!]!
  """Preflight reports for this component"""
  preflightReports: [PreflightReportState!]!
  """Desired substrate/paper for this component"""
  desiredSubstrate: SubstrateState
  """Actual substrate/paper used for this component"""
  actualSubstrate: SubstrateState
}

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