Skip to content

ProductionReportState ​

Type: Object

Production observation. May be partner-sourced, manual, or system-generated; binding refs are optional.

Fields ​

NameTypeArgsDescriptionDeprecated
actualPrintingDurationSecondsFloatEngaged production time in seconds — machine actually running. Distinct from the endedAt - startedAt wall clock, which can include pauses.
areaPrintedAreaTotal area printed.
averageSpeedSpeedMean production rate over the run, as a value plus its speed unit. Null when the source reported no speed.
bindingMethodProductionReportBindingMethodHow the binding refs were established (ingested / manual / auto). Null while the report is still unbound.
boundAtISO8601When the report was bound to canonical entities (ISO8601).
capabilityCodeCapabilityCodeThe kind of operation this report describes (e.g. printing, cutting). Determines which operationData paths are meaningful. Optional — partner reports may omit it, and it can be inferred from the bound operation later.
componentIdComponentIDBinding ref: TypeID of the Component this report was produced for (cmp_…). Null until the report is bound.
consumption[ProductionReportConsumptionState!]!Consumption rows attached to this report (ink, substrate, …). Requires productionReport:read.
countUnitMetricUnitUnit that goodCount and totalPlanned are counted in (e.g. sheets, metres). CUSTOM means the real unit name is in customCountUnit.
createdAtString!When the report row was written (ISO8601). This is ingestion time, not production time — use startedAt for when the run actually happened.
customCountUnitStringVertical-specific count unit name, meaningful only when countUnit is CUSTOM. Null otherwise.
endedAtISO8601When the reported run finished (ISO8601). Null for a run that is still open or for a source that reported no timing.
errorCodeStringMachine- or partner-defined error code raised during the run. Null for a run that reported no error.
errorMessageStringHuman-readable description of the error named by errorCode. Null when no error occurred.
errorSeverityProgressErrorSeverityHow serious the reported error was. Null when no error occurred.
externalRefs[ExternalRef!]Binding-grade external references from the source system, used by the binding mutation to resolve this report against canonical entities. Null when the source supplied none.
goodCountFloatSaleable output produced by this run, expressed in countUnit. Waste is deliberately not broken out separately for partner-sourced data.
groupingKeys[Dictionary!]!Partner-internal grouping keys as a JSON object (key → value strings).
idProductionReportID!TypeID of the production report (prr_…). Stable for the lifetime of the row.
integrationInstanceIdIntegrationInstanceIDSource integration that produced the report.
isUnboundBoolean!True iff no binding refs are set.
jobIdJobIDBinding ref: TypeID of the Job this report was produced for (job_…). Null until the report is bound; only the binding mutation may set it.
lengthPrintedLengthLength of the print run, with unit provenance preserved.
metadataJSONFreeform integration metadata. Native JSON — numbers stay numbers, nested structures preserved verbatim.
nameStringDisplay name.
operationDataJSONCapability-keyed flat path map. Native JSON object with JSON-Pointer-style keys; numeric values are emitted as JSON numbers.
operationIdOperationIDBinding ref: TypeID of the Operation the report describes (opr_…). Null until the report is bound.
operationItemIdOperationItemIDBinding ref: TypeID of the OperationItem the report describes (opi_…). Null until the report is bound.
operatorIdentifierStringFree-form operator identifier from the source system, when no user maps to it.
printColorPolicyStringColor matching policy. Read from operationData["/colorPolicy"].
printDirectionStringBidirectional/unidirectional. Read from operationData["/direction"].
printDpiHorizontalIntHorizontal print resolution (DPI). Read from operationData["/dpi/horizontal"].
printDpiVerticalIntVertical print resolution (DPI). Read from operationData["/dpi/vertical"].
printModeStringPrint mode (vendor-specific string). Read from operationData["/mode"].
printPassesIntNumber of print passes. Read from operationData["/passes"].
printSaveInkMethodStringInk-save method. Read from operationData["/saveInkMethod"].
printSpeedModeStringSpeed mode (vendor-specific string). Read from operationData["/speedMode"].
runKindRunKindWhether this report describes real production output or a non-production run (setup, proof, calibration, test). Null means unspecified — treated as PRODUCTION by downstream filters.
startedAtISO8601When the reported run began (ISO8601). Null when the source system reported counts without timing.
substrateIdSubstrateIDFK to the typed Substrate catalog entry, when one was matched.
substrateLengthLengthSubstrate roll/sheet length.
substrateNameStringSubstrate display name as reported by the source.
substrateThicknessLengthSubstrate caliper / thickness.
substrateTypeStringSubstrate type / material as reported by the source.
substrateWeightPaperWeightSubstrate basis weight.
substrateWidthLengthSubstrate roll/sheet width.
totalPlannedFloatQuantity the run was planned to produce, in countUnit — the denominator for completion against goodCount. Null when the source reported no plan.
updatedAtString!When the row last changed (ISO8601). Payload columns are immutable after first write, so this only moves when the binding refs are set.
userIdUserIDUser associated with this report (typically the operator on duty).
widthPrintedLengthWidth of the print run, with unit provenance preserved.
workCenterIdWorkCenterIDBinding ref: TypeID of the WorkCenter (machine/cell) the output came from (wcr_…). Null until the report is bound.

Relationships ​

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