Skip to content

OperationState ​

Type: Object

An operation within a job

Fields ​

NameTypeArgsDescriptionDeprecated
actualCompletionAtISO8601Actual completion time (ISO8601)
actualStartAtISO8601Actual start time (ISO8601)
capabilityIdCapabilityIDPreferred capability (id) for scheduling
componentComponentStateParent component. Requires component:read permission.
componentGroupComponentGroupStateParent component group. Requires componentGroup:read permission.
componentGroupIdComponentGroupIDAssociated component group ID
componentIdComponentIDAssociated component ID
createdAtISO8601!Creation timestamp (ISO8601)
customKindStringCustom operation type name (when kind is custom)
deadlineISO8601Deadline (ISO8601)
expectedDurationIntExpected duration in seconds
externalIdStringExternal system ID
idOperationID!Unique identifier
items[OperationItemState!]!Physical work units (items) within this operation. Requires operation:read permission.
jobJobStateParent job. Requires job:read permission.
jobIdJobID!Parent job ID
kindOperationKind!Operation type
metadataJSONMapAdditional metadata as JSON object
milestoneMilestoneStateAssociated milestone. Requires milestone:read permission.
milestoneIdMilestoneIDAssociated milestone ID
nameString!Operation name
outsourcedLeadTimeDaysIntExpected lead time in calendar days for outsourced operations
outsourcedPurchaseOrderIdPurchaseOrderIDPurchase order covering this outsourced operation
outsourcedSupplierIdSupplierIDSupplier this operation is subcontracted to (nil = in-house)
parametersJSONKind-specific production parameters (JSON). Schema varies by kind — use getOperationParameterSchema to retrieve the JSON Schema for the target kind.
productionQuantityIntProduction quantity
remarksStringNotes and remarks
requestedWorkCenterWorkCenterStateRequested work center. Requires workCenter:read permission.
requestedWorkCenterIdWorkCenterIDPreferred work center for scheduling
requiredResourceTypeStringType of resource required
scheduledCompletionAtISO8601Scheduled completion time (ISO8601)
scheduledStartAtISO8601Scheduled start time (ISO8601)
sortOrderInt!Sort order within the job
statusOperationStatus!Current operation status
updatedAtISO8601!Last update timestamp (ISO8601)

Relationships ​

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