ComponentState
A component within a job
Fields
Unique identifier
Parent job ID
Parent component group ID (nil for ungrouped components)
Internal component number
External URL for the calling integration, or the primary identity for unscoped callers.
All linked external identities, including identities belonging to other integrations.
Integration instance that originally created this record, when known.
IaC stack that originally created this record, when known.
External system ID
Component name
Component description
Component classification
Possible values (9)
CONTENTGeneral content pages
COVERCover component
INSERTBound-in insert
MAINMain component of a single-component job
TEXTText block pages
DUST_JACKETDust jacket wrapper for case-bound books
ENDPAPEREndpapers/pastedowns
OUTSERTOutsert/wrap-around component
OTHERUncategorized component
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
Referenced by (15)
- AcceptEstimatePayload.components
- ComponentArtworkFileState.component
- ComponentEdge.node
- ComponentGroupState.components
- ImpositionSpecState.component
- InstantiateProductTemplatePayload.components
- JobState.components
- MilestoneState.component
- OperationState.component
- PreflightReportState.component
- PrepressOperationState.component
- ProductionBoardJob.components
- Query.getComponent
- Query.getComponentBy
- UpsertComponentPayload.component
Exact type 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 URL for the calling integration, or the primary identity for unscoped callers.
"""
externalUrl: String @iac_computed
"""
All linked external identities, including identities belonging to other integrations.
"""
externalIdentities: [RecordExternalIdentity!]! @iac_computed
"""Integration instance that originally created this record, when known."""
createdByIntegrationId: IntegrationInstanceID @iac_computed @iac_ref(resource: "integration_instance")
"""IaC stack that originally created this record, when known."""
createdByStackId: IaCStackID @iac_computed
"""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
}