Prepress
Print prepress
Explore the data types and operations available in Print prepress.
81 operations
Calculate imposition layout for a component and create ImpositionSpec records. Finished size, bleed, page count, and quantity are read from the component. Requires impositionSpec:write permission.
consolidateImpositionFinishingQueryDerive finishing geometry without persistence. Requires impositionSpec:execute. Supply impositionSpecId or layout.
createImpositionSpecMutationCreate a new component or BatchComponent imposition specification. Requires impositionSpec:write permission.
createSubstrateMutationCreate a new substrate, failing if the code is already taken. Requires substrate:write permission.
createSubstrateTemplateLineMutationCreate a new substrate template line. Requires substrateTemplateLine:write permission.
deleteComponentArtworkFileMutationRemove an artwork file reference from a component. Requires componentArtworkFile:delete permission.
deleteImpositionSpecMutationRemove an imposition spec from a component. Requires impositionSpec:delete permission.
deletePreflightReportMutationDelete a preflight report. Requires preflightReport:delete permission.
deletePrepressOperationMutationDelete a prepress operation. Requires prepressOperation:delete permission.
deleteSubstrateMutationDelete a substrate. Requires substrate:delete permission.
deleteSubstrateTemplateLineMutationDelete a substrate template line. Requires substrateTemplateLine:delete permission.
extractProductionQueryExtract ISO 19593-1 production steps from supplied PDF bytes inline (not persisted) — inspect before creating Operations. Requires operation:read permission.
extractProductionOperationsMutationExtract ISO 19593-1 production steps from an artwork file and derive Operations (optionally persisting them). Requires operation:write permission.
getComponentArtworkFileQueryFetch a component artwork file reference by ID. Requires componentArtworkFile:read permission.
getImpositionSpecQueryFetch an imposition spec by ID. Requires impositionSpec:read permission.
getImpositionSpecByQueryFetch an imposition spec by external ID. Requires impositionSpec:read permission.
getPreflightReportQueryFetch a preflight report by ID. Requires preflightReport:read permission.
getPrepressOperationQueryFetch a prepress operation by ID. Requires prepressOperation:read permission.
getPrintOperationProductQueryRead and inspect a retained print sheet product. Returns null for an absent or non-print product. Requires operation read permission; no file download or inventory change occurs.
getSubstrateQueryFetch a substrate by ID. Requires substrate:read permission.
getSubstrateByQueryFetch a substrate by external ID. Requires substrate:read permission.
getSubstrateTemplateLineQueryFetch a single substrate template line by ID. Requires substrateTemplateLine:read permission.
imposePdfInlineQueryCompose real source PDF pages using a previously calculated signature, repeat, cut-stack or wide-format tiling plan. Returns PDF bytes without persistence or cloud storage; does not calculate geometry or repeat forms by quantity. Requires impositionSpec:execute permission and the native PDF-Writer backend.
installCanonicalTemplateMutationInstall a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
instantiateProductTemplateMutationInstantiate a published product template into a print job. Requires productTemplate:execute permission.
jobSignaturesQueryFind every qualified signature of a job across existing plans, current operation work and historical retained products. Requires job, component, imposition-spec and operation read permissions. Reports unknown legacy identities explicitly; neither publication nor physical production is inferred.
listComponentArtworkFilesQueryList artwork file references for a component. Requires componentArtworkFile:list permission.
listFoldPatternsQueryList all available fold patterns from the catalog. Requires authentication.
listImpositionSpecsQueryList imposition specs for exactly one component or batch form. Requires impositionSpec:list permission.
listPreflightReportsQueryList preflight reports for a component. Requires preflightReport:list permission.
listPrepressOperationsQueryList prepress operations for a component. Requires prepressOperation:list permission.
listSubstratesQueryList substrates with pagination and filtering. Requires substrate:list permission.
listSubstrateTemplateLinesQueryList substrate template lines for a product template. Requires substrateTemplateLine:list permission.
planBookContentQueryPlan a gathered or explicitly nested cross-component book without writes or PDF downloads. Persisted routes additionally require job:read, component:read, substrate:read, componentArtworkFile:read and file:read. Existing JSON APIs are unchanged.
planBookCoverQueryResolve one book and calculate its block and cover. Job/component sources additionally require job:read, component:read and substrate:read. No persistence or automatic acceptance of inference.
planRollLabelsQueryPlan rectangular roll labels through typed inputs without persistence or PDF inspection. Supports fixed lanes, bounded search, complete-repeat delivery and separate declared-limit assessments. Requires impositionSpec:read; persisted sources additionally require job:read, component:read, operation:read, substrate:read, componentArtworkFile:read and file:read.
planWideFormatTilingQueryCalculate up to 256 native-scale panels with typed quantities. No PDF inspection, persistence, machine selection or cutting setup. Requires impositionSpec:read.
preflightCheckQueryRun preflight on supplied PDF bytes inline (not persisted). Requires preflightReport:read permission.
prepareBatchFormQueryValidate and prepare a saved form Layout and original source signatures without producing inventory
prepareBookContentRenderQueryResolve a book and inspect actual PDFs without composing output. Requires impositionSpec:read. Managed routes also require all planning read permissions and file:download. Sources are limited to 16 MiB each and 32 MiB combined.
prepareCarrierProductQueryValidate one composed signature carrier against captured PDFs without producing output or writing records. Managed routes require existing planning reads and file download. Sources are limited to 16 MiB each and 32 MiB combined.
prepareFoldedProductsQueryValidate full-material fold geometry and retained production identity without writes or source downloads. Preserves historical printed artwork even when the current artwork changes.
prepareRollLabelRenderQueryResolve a typed roll plan and inspect its actual PDFs without rendering. Returns identities for later freshness comparison. Requires impositionSpec:read; persisted inputs also require the planning read permissions and file:download.
prepareSheetProductsQueryReplan and validate managed source bytes for physical sheet products without writing records. Existing impositionSpec read and managed file download permissions are also required.
prepareSignatureSeparationQueryValidate retained separation geometry and each output's original graph route without writes or source downloads. Historical artwork is preserved.
previewBookCover (deprecated)QueryReconcile explicit softcover or case-wrap construction against a calibrated physical book block without persistence. Rejects inconsistent spine, face dimensions, recipe revision and binding direction. Does not generate production artwork.
previewImpositionQueryPreview imposition layout without creating records. Used for estimation when no component exists yet.
previewRollLabelsQueryPlan explicit rectangular label lanes and reconcile SKU demand and overrun without persistence. Includes cyclic bleed clearances and stock length. Does not certify tooling, slitting, matrix stripping or rewind delivery.
previewShapeNestingQueryPlan and independently validate a bounded batch of polygonal pieces without persistence. Deterministic orthogonal heuristic, not an optimum guarantee. At most 256 pieces and 4096 placed vertices; hole nesting requires explicit opt-in. Produces geometry only, not a production PDF or cutter programme.
previewSignatureSeparationQueryPreview separation without persisted production records using existing source-observed carrier preparation. No routes, graph writes or inventory are created. Existing carrier source limits apply.