Skip to content

ComponentState ​

Type: Object

A component within a job

Fields ​

NameTypeArgsDescriptionDeprecated
actualSubstrateSubstrateStateActual substrate/paper used for this component
actualSubstrateIdSubstrateIDActual substrate/paper ID
artworkFiles[ComponentArtworkFileState!]!Artwork files attached to this component
colorsComponentColorInfoColor specification for front and back
componentGroupComponentGroupStateParent component group. Requires componentGroup:read permission.
componentGroupIdComponentGroupIDParent component group ID (nil for ungrouped components)
createdAtISO8601!Creation timestamp (ISO8601)
descriptionStringComponent description
desiredSubstrateSubstrateStateDesired substrate/paper for this component
desiredSubstrateIdSubstrateIDDesired substrate/paper ID
externalIdStringExternal system ID
finishedSizeMediaFinished size after trimming
finishingFinishingSpecFinishing specification (varnish, die, foil, emboss)
idComponentID!Unique identifier
impositionSpecs[ImpositionSpecState!]!Imposition specifications for this component
jobJobStateParent job. Requires job:read permission.
jobIdJobID!Parent job ID
kindComponentKind!Component classification
layoutComponentLayoutLayout specification with layers
mediaMediaMedia/paper specification
milestones[MilestoneState!]!Component-scoped milestones (does not include job-wide milestones). Requires milestone:list permission.
nameString!Component name
operations[OperationState!]!Operations for this component. Requires operation:list permission.
preflightReports[PreflightReportState!]!Preflight reports for this component
prepressOperations[PrepressOperationState!]!Prepress operations for this component
quantityInt!Number of units
sortOrderInt!Sort order within the job
totalPagesIntTotal number of pages
updatedAtISO8601!Last update timestamp (ISO8601)

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.