Prepress API reference
Use the Prepress guide for workflows and examples. This reference accounts for operations here and in the linked guides carrying the print.prepress or files or workflows topic, including shared tools. Infrastructure changes are marked for IaC. Admin marks shared administrative configuration, not job data.
A trailing ! means a value is required; [Type!] means a list whose entries cannot be null. Defaults below are those declared by the API. Additional business rules are explained in the guide.
Receive and organise production files
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getFile |
id: FileID! |
FileState |
Read a file. | API |
listFiles |
first: Int, after: String, filter: FileFilterInput, sort: [FileSortInput!] |
FileConnection! |
Browse files. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertFile |
input: UpsertFileInput! |
UpsertFilePayload! |
Advanced: create or update an external file record. Prefer create/update for routine changes. | API |
createFile |
input: CreateFileInput! |
UpsertFilePayload! |
Register a file held in external storage. | API |
updateFile |
id: FileID!, input: UpdateFileInput! |
UpsertFilePayload! |
Change metadata for an existing file. | API |
deleteFile |
id: FileID! |
DeletePayload! |
Delete a file. | API |
requestFileUploads |
inputs: [RequestFileUploadInput!]! |
RequestFileUploadsPayload! |
Allocate upload URLs and records for managed cloud files. | API |
completeFileUploads |
inputs: [CompleteFileUploadInput!]! |
CompleteFileUploadsPayload! |
Confirm completed uploads and mark their files ready. | API |
fileDownloadUrl |
id: FileID! |
FileDownloadGrant! |
Obtain a download address for an authorised file. | API |
Choose configured folders and storage
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getS3Backend |
id: StorageBackendID! |
S3Backend |
Read a s3backend. | API |
getHostPathBackend |
id: StorageBackendID! |
HostPathBackend |
Read a configured filesystem storage connection. | API |
getFTPBackend |
id: StorageBackendID! |
FTPBackend |
Read a ftpbackend. | API |
getGoogleDriveBackend |
id: StorageBackendID! |
GoogleDriveBackend |
Read a google drive backend. | API |
getDropboxBackend |
id: StorageBackendID! |
DropboxBackend |
Read a dropbox backend. | API |
getStorageBackend |
id: StorageBackendID! |
StorageBackendOutput |
Read a storage backend. | API |
listStorageBackends |
first: Int, after: String, filter: StorageBackendFilterInput, sort: [StorageBackendSortInput!] |
StorageBackendConnection! |
Browse storage backends. | API |
storageCapabilities |
None | StorageCapabilitiesOutput! |
Read the supported storage connection kinds. | API |
folder |
id: FolderID! |
Folder |
Read a configured folder. | API |
folders |
first: Int, after: String, filter: FolderFilterInput, sort: [FolderSortInput!] |
FolderConnection! |
Browse configured folders. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createStorageBackendAuthorization |
input: CreateStorageBackendAuthorizationInput! |
CreateStorageBackendAuthorizationPayload! |
Start an interactive provider consent flow. Connection setup, not artwork preparation. | Setup |
upsertStorageBackend |
input: UpsertStorageBackendInput! |
UpsertStorageBackendPayload! |
Advanced: create or update a storage backend. Manage through IaC. | IaC |
createStorageBackend |
input: CreateStorageBackendInput! |
UpsertStorageBackendPayload! |
Create a storage backend. Manage through IaC. | IaC |
updateStorageBackend |
id: StorageBackendID!, input: UpdateStorageBackendInput! |
UpsertStorageBackendPayload! |
Change a storage backend. Manage through IaC. | IaC |
deleteStorageBackend |
id: StorageBackendID! |
DeletePayload! |
Delete a storage backend. Manage through IaC. | IaC |
testStorageBackend |
id: StorageBackendID! |
StorageBackendProbeResult! |
Check a configured storage connection without writing files. | API |
createFolder |
input: CreateFolderInput! |
FolderPayload! |
Create a folder. Manage through IaC. | IaC |
updateFolder |
id: FolderID!, input: UpdateFolderInput! |
FolderPayload! |
Change a folder. Manage through IaC. | IaC |
deleteFolder |
id: FolderID! |
DeletePayload! |
Delete a folder. Manage through IaC. | IaC |
testFolder |
id: FolderID! |
FolderProbeResult! |
Check folder reachability without writing files. | API |
Connect artwork to the component
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getComponentArtworkFile |
id: ComponentArtworkFileID! |
ComponentArtworkFileState |
Read a component artwork file. | API |
listComponentArtworkFiles |
componentId: ComponentID! |
[ComponentArtworkFileState!]! |
Browse component artwork files. | API |
getPrepressOperation |
id: PrepressOperationID! |
PrepressOperationState |
Read a prepress operation. | API |
listPrepressOperations |
componentId: ComponentID! |
[PrepressOperationState!]! |
Browse prepress operations. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertComponentArtworkFile |
input: UpsertComponentArtworkFileInput! |
UpsertComponentArtworkFilePayload! |
Create or update a component artwork file. | API |
deleteComponentArtworkFile |
input: DeleteComponentArtworkFileInput! |
DeleteComponentArtworkFilePayload! |
Delete a component artwork file. | API |
upsertPrepressOperation |
input: UpsertPrepressOperationInput! |
UpsertPrepressOperationPayload! |
Create or update a prepress operation. | API |
deletePrepressOperation |
input: DeletePrepressOperationInput! |
DeletePrepressOperationPayload! |
Delete a prepress operation. | API |
Check artwork and inspect separations
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getPreflightReport |
id: PreflightReportID! |
PreflightReportState |
Read a preflight report. | API |
listPreflightReports |
componentId: ComponentID! |
[PreflightReportState!]! |
Browse preflight reports. | API |
renderArtworkPreview |
input: RenderArtworkPreviewInput! |
RenderArtworkPreviewPayload! |
Preview an artwork file. | API |
preflightCheck |
input: PreflightCheckInput! |
PreflightCheckPayload! |
Check an artwork file without saving a report. | API |
renderPreview |
input: RenderPreviewInput! |
RenderArtworkPreviewPayload! |
Create a document preview. | API |
renderPlateSeparation |
input: RenderPlateSeparationInput! |
RenderArtworkPreviewPayload! |
Preview a plate separation. | API |
renderSeparation |
input: RenderSeparationInput! |
RenderArtworkPreviewPayload! |
Preview a colour separation. | API |
extractProduction |
input: ExtractProductionInput! |
ExtractProductionPayload! |
Read a production instructions from artwork. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertPreflightReport |
input: UpsertPreflightReportInput! |
UpsertPreflightReportPayload! |
Create or update a preflight report. | API |
deletePreflightReport |
input: DeletePreflightReportInput! |
DeletePreflightReportPayload! |
Delete a preflight report. | API |
runPreflight |
input: RunPreflightInput! |
RunPreflightPayload! |
Check artwork and save a preflight report. | API |
extractProductionOperations |
input: ExtractProductionOperationsInput! |
ExtractProductionOperationsPayload! |
Read production steps from artwork, with the option to save them. | API |
Prepare imposition and production output
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getImpositionSpec |
id: ImpositionSpecID! |
ImpositionSpecState |
Read an imposition spec. | API |
listImpositionSpecs |
componentId: ComponentID! |
[ImpositionSpecState!]! |
Browse imposition specs. | API |
previewImposition |
input: PreviewImpositionInput! |
PreviewImpositionPayload! |
Preview a sheet layout before saving an imposition specification. | API |
listFoldPatterns |
None | FoldCatalogPayload! |
Browse the available fold patterns. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
upsertImpositionSpec |
input: UpsertImpositionSpecInput! |
UpsertImpositionSpecPayload! |
Create or update an imposition spec. | API |
deleteImpositionSpec |
input: DeleteImpositionSpecInput! |
DeleteImpositionSpecPayload! |
Delete an imposition spec. | API |
imposePdfInline |
input: ImposePdfInlineInput! |
ImposePdfInlinePayload! |
Create an imposed PDF from an existing signature plan. | API |
calculateImposition |
input: CalculateImpositionInput! |
CalculateImpositionPayload! |
Calculate and save imposition specifications for a component. | API |
renderImpositionSVG |
input: RenderImpositionSVGInput! |
RenderImpositionSVGPayload! |
Draw an imposition layout as SVG. | API |
consolidateImpositionFinishing |
input: ConsolidateFinishingInput! |
ConsolidateFinishingPayload! |
Review the finishing steps for an imposition without saving changes. | API |
Run configured prepress workflows
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getWorkflow |
id: WorkflowID! |
WorkflowState |
Read a workflow. | API |
listWorkflows |
first: Int, last: Int, after: String, before: String, filter: WorkflowFilterInput, sort: [WorkflowSortInput!] |
WorkflowConnection! |
Browse workflows. | API |
getWorkflowVersion |
id: WorkflowVersionID! |
WorkflowVersionState |
Read a workflow version. | API |
listWorkflowVersions |
first: Int, last: Int, after: String, before: String, filter: WorkflowVersionFilterInput, sort: [WorkflowVersionSortInput!] |
WorkflowVersionConnection! |
Browse workflow versions. | API |
workflowTrigger |
id: WorkflowTriggerID! |
WorkflowTriggerState |
Read a configured workflow trigger. | API |
workflowTriggers |
workflowId: WorkflowID! |
[WorkflowTriggerState!]! |
Read the triggers for a workflow. | API |
allWorkflowTriggers |
None | [WorkflowTriggerState!]! |
Read the configured triggers. | API |
getExecution |
id: WorkflowExecutionID! |
WorkflowExecutionState |
Read a execution. | API |
listExecutions |
first: Int, last: Int, after: String, before: String, filter: WorkflowExecutionFilterInput, sort: [WorkflowExecutionSortInput!] |
WorkflowExecutionConnection! |
Browse executions. | API |
getExecutionSteps |
executionId: WorkflowExecutionID! |
[WorkflowExecutionStepState!]! |
Read a execution steps. | API |
listExecutionLogs |
contextType: ExecutionLogContextType!, contextId: String!, level: ExecutionLogLevel, first: Int, after: String |
ExecutionLogConnection! |
Read execution logs for a selected context. | API |
queryProgressPoints |
filter: ProgressPointFilterInput, first: Int, after: String |
ProgressPointConnection! |
Browse recorded production progress. | API |
latestProgress |
operationId: OperationID! |
ProgressPointState |
Read the latest recorded progress for a production operation. | API |
workflowRunStats |
workflowId: WorkflowID!, since: ISO8601!, until: ISO8601, bucketMinutes: Int = 60 |
WorkflowRunStats! |
Review workflow run totals, durations and node outcomes over a time window. | API |
workflowRunHealth |
since: ISO8601! |
[WorkflowRunHealth!]! |
Review failures, waiting runs and the latest run status across workflows. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
executeWorkflow |
input: ExecuteWorkflowInput! |
ExecuteWorkflowPayload! |
Start a run of a configured workflow. | API |
cancelExecution |
id: WorkflowExecutionID! |
CancelExecutionPayload! |
Request cancellation of a running workflow. | API |
resumeWorkflowExecution |
id: WorkflowExecutionID! |
WorkflowExecutionPayload! |
Resume a workflow waiting for an external signal. | API |
recordProgressPoints |
input: RecordProgressPointsInput! |
RecordProgressPointsPayload! |
Record production progress observations. | API |
Manage reusable automation through IaC
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
analyzeWorkflowSource |
sourceXML: String! |
String! |
Inspect the underlying workflow format for advanced tooling. | Advanced reference |
getWorkflowVersionSource |
id: WorkflowVersionID! |
WorkflowVersionSource |
Read the underlying source of a configured workflow version. | Advanced reference |
getWorkflowSchema |
None | String! |
Read the workflow definition contract for advanced tooling. | Advanced reference |
workflowExecutionRuntimeManagement |
id: WorkflowExecutionID! |
WorkflowExecutionRuntimeManagementState |
Inspect workflow recovery state. Administrative recovery. | Admin |
getTemplate |
id: TemplateID! |
TemplateState |
Read a template. | API |
getTemplateByHandle |
handle: String! |
TemplateState |
Read a template by handle. | API |
listTemplates |
first: Int, last: Int, after: String, before: String, filter: TemplateFilterInput, sort: [TemplateSortInput!] |
TemplateConnection! |
Browse templates. | API |
getTemplateVersion |
id: TemplateVersionID! |
TemplateVersionState |
Read a template version. | API |
listTemplateVersions |
templateId: TemplateID!, first: Int, after: String |
TemplateVersionConnection! |
Browse template versions. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createWorkflow |
input: CreateWorkflowInput! |
WorkflowPayload! |
Create a workflow. Manage through IaC. | IaC |
updateWorkflow |
id: WorkflowID!, input: UpdateWorkflowInput! |
WorkflowPayload! |
Change a workflow. Manage through IaC. | IaC |
deleteWorkflow |
id: WorkflowID! |
DeleteWorkflowPayload! |
Delete a workflow. Manage through IaC. | IaC |
deleteWorkflowVersion |
id: WorkflowVersionID! |
DeletePayload! |
Delete a workflow version. Manage through IaC. | IaC |
deleteWorkflowVersionIfExists |
id: WorkflowVersionID! |
DeletePayload! |
Delete a workflow version if exists. Manage through IaC. | IaC |
createWorkflowVersionFromSource |
input: CreateWorkflowVersionFromSourceInput! |
WorkflowVersionSourcePayload! |
Create a workflow version from source. Manage through IaC. | IaC |
createWorkflowVersion |
input: CreateWorkflowVersionInput! |
WorkflowVersionPayload! |
Create a workflow version. Manage through IaC. | IaC |
setActiveVersion |
workflowId: WorkflowID!, versionId: WorkflowVersionID |
SetActiveVersionPayload! |
Select a workflow’s active version. Manage through IaC. | IaC |
exportWorkflow |
input: ExportWorkflowInput! |
ExportWorkflowPayload! |
Export a workflow version for advanced tooling. | Advanced reference |
importWorkflow |
input: ImportWorkflowInput! |
ImportWorkflowPayload! |
Import a workflow version. Define reusable workflows through IaC. Manage through IaC. | IaC |
validateWorkflow |
input: ValidateWorkflowInput! |
ValidateWorkflowPayload! |
Validate a workflow definition without saving it. | Advanced reference |
createWorkflowTrigger |
input: CreateWorkflowTriggerInput! |
WorkflowTriggerPayload! |
Create a workflow trigger. Manage through IaC. | IaC |
updateWorkflowTrigger |
id: WorkflowTriggerID!, input: UpdateWorkflowTriggerInput! |
WorkflowTriggerPayload! |
Change a workflow trigger. Manage through IaC. | IaC |
deleteWorkflowTrigger |
input: DeleteWorkflowTriggerInput! |
WorkflowTriggerPayload! |
Delete a workflow trigger. Manage through IaC. | IaC |
enableWorkflowTrigger |
input: EnableWorkflowTriggerInput! |
WorkflowTriggerPayload! |
Enable a configured trigger. Manage through IaC. | IaC |
disableWorkflowTrigger |
input: DisableWorkflowTriggerInput! |
WorkflowTriggerPayload! |
Disable a configured trigger. Manage through IaC. | IaC |
reconcileWorkflowExecutionRuntime |
id: WorkflowExecutionID!, expectedGeneration: String, expectedRunner: String, expectedSession: String, expectedAuthority: String, expectedRevision: String, expectedStatus: String, expectedRowVersion: String, confirmedTerminationEvidence: String! |
WorkflowExecutionPayload! |
Reconcile a stopped execution before recovery. Administrative recovery. | Admin |
resolveNodeOutputSchema |
input: ResolveNodeOutputSchemaInput! |
NodeOutputSchemaPayload! |
Inspect the output contract of a configured workflow step. | Advanced reference |
validateJinja |
input: ValidateJinjaInput! |
ValidateJinjaResult! |
Check an expression without evaluating it. | Advanced reference |
upsertTemplate |
input: UpsertTemplateInput! |
UpsertTemplatePayload! |
Advanced: create or update a template. Manage through IaC. | IaC |
createTemplate |
input: CreateTemplateInput! |
UpsertTemplatePayload! |
Create a template. Manage through IaC. | IaC |
updateTemplate |
id: TemplateID!, input: UpdateTemplateInput! |
UpsertTemplatePayload! |
Change a template. Manage through IaC. | IaC |
deleteTemplate |
id: TemplateID! |
DeleteTemplatePayload! |
Delete a template. Manage through IaC. | IaC |
validateTemplate |
input: ValidateTemplateInput! |
ValidateTemplatePayload! |
Check reusable text-template syntax without saving it. | Advanced reference |
publishTemplateVersion |
input: PublishTemplateVersionInput! |
PublishTemplateVersionPayload! |
Publish a reusable text-template version. Manage through IaC. | IaC |
deleteTemplateVersion |
id: TemplateVersionID! |
DeletePayload! |
Delete a template version. Manage through IaC. | IaC |
restoreTemplateVersion |
input: RestoreTemplateVersionInput! |
UpsertTemplatePayload! |
Restore a reusable text template from a version. Manage through IaC. | IaC |
renderTemplate |
input: RenderTemplateInput! |
RenderTemplatePayload! |
Render a configured text template with supplied data. | API |
Subscription
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
executionLogStream |
contextType: ExecutionLogContextType!, contextId: String! |
ExecutionLogState! |
Follow new execution log entries. | API |
Read configured paper and print settings
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
getSubstrate |
id: SubstrateID! |
SubstrateState |
Read a substrate. | API |
getSubstrateBy |
externalId: String |
SubstrateState |
Read substrate by its identifying fields. | API |
listSubstrates |
first: Int, after: String, filter: SubstrateFilterInput, sort: [SubstrateSortInput!] |
SubstrateConnection! |
Browse substrates. | API |
getSubstrateTemplateLine |
id: SubstrateTemplateLineID! |
SubstrateTemplateLineState |
Read a substrate template line. | API |
listSubstrateTemplateLines |
productTemplateId: ProductTemplateID! |
[SubstrateTemplateLineState!]! |
Browse substrate template lines. | API |
Mutation
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
createSubstrate |
input: CreateSubstrateInput! |
UpsertSubstratePayload! |
Create a substrate. Manage through IaC. | IaC |
updateSubstrate |
id: SubstrateID!, input: UpdateSubstrateInput! |
UpsertSubstratePayload! |
Change a substrate. Manage through IaC. | IaC |
upsertSubstrate |
input: UpsertSubstrateInput! |
UpsertSubstratePayload! |
Create or update a substrate. Manage through IaC. | IaC |
deleteSubstrate |
id: SubstrateID! |
DeletePayload! |
Delete a substrate. Manage through IaC. | IaC |
createSubstrateTemplateLine |
input: CreateSubstrateTemplateLineInput! |
UpsertSubstrateTemplateLinePayload! |
Create a substrate template line. Manage through IaC. | IaC |
updateSubstrateTemplateLine |
id: SubstrateTemplateLineID!, input: UpdateSubstrateTemplateLineInput! |
UpsertSubstrateTemplateLinePayload! |
Change a substrate template line. Manage through IaC. | IaC |
upsertSubstrateTemplateLine |
input: UpsertSubstrateTemplateLineInput! |
UpsertSubstrateTemplateLinePayload! |
Create or update a substrate template line. Manage through IaC. | IaC |
deleteSubstrateTemplateLine |
id: SubstrateTemplateLineID! |
DeletePayload! |
Delete a substrate template line. Manage through IaC. | IaC |
updatePaperWeightSettings |
input: PaperWeightSettingsInput! |
UpdatePaperWeightSettingsPayload! |
Change paper weight settings. Administrative configuration. | Admin |
updateImposingSettings |
input: ImposingSettingsInput! |
UpdateImposingSettingsPayload! |
Change imposing settings. Administrative configuration. | Admin |
Discover the API and get help
Query
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
magicQuery |
query: QueryScalar! |
JSON! |
Read data with a compact named query | API |
getMagicQuerySchema |
query: QueryScalar! |
MagicQuerySchema! |
Inspect the inputs and result of a compact named query | API |
listMagicQueries |
None | [MagicQueryInfo!]! |
Discover the available compact named queries | API |
getMagicQueryGraphQL |
query: QueryScalar! |
MagicQueryOperation! |
Inspect the GraphQL operation for a compact named query | API |
listDataChangeEventTopics |
None | [DataChangeEventGroup!]! |
Discover record-change event topics | API |
generateDefaultDataQuery |
topic: String! |
String |
Prepare a query for a record-change event | API |
ping |
None | String! |
Check whether the API responds | API |
iacSchema |
None | IaCSchemaDocument! |
Read the infrastructure schema for IaC tooling | API |
iacValidate |
validator: String!, source: String!, role: String |
IaCValidationResult! |
Validate an IaC source document | API |
iacGuides |
None | [IaCGuide!]! |
Read IaC authoring guides | API |
helpChapters |
None | [HelpChapterInfo!]! |
Discover help chapters | API |
helpChapter |
family: String!, slug: String! |
HelpChapter |
Read a help chapter | API |
searchHelp |
query: String!, family: String |
HelpSearchResult! |
Find help by search term | API |
schemaAuthoringCatalog |
None | JSON! |
Discover supported schema authoring features | API |
compileSchemaXML |
sourceXML: String! |
String! |
Convert an authored XML schema to JSON Schema | API |
renderSchemaXML |
schemaJSON: String! |
String! |
Convert JSON Schema to authored XML | API |
iacSchemaDocument |
ref: String! |
IaCSchemaDocumentPayload! |
Read a schema document used by IaC tooling | API |
topicExamples |
names: [String!]! |
[TopicExample!]! |
Retrieve named examples with their operations and variables. | API |
Subscription
| Operation | Arguments | Result | Use it to | Use through |
|---|---|---|---|---|
dataChangeEvents |
topics: [String!]! |
DataChangeEvent! |
Subscribe to record-change events | API |
Operations covered in related guides
These operations belong to the selected topics but are documented in the guide where their workflow belongs.
| Operation | Guide |
|---|---|
Mutation.installCanonicalTemplate |
Production |
Mutation.instantiateProductTemplate |
Production |
Query.productionSnapshot |
Production |
Types
These tables cover operation inputs, their nested inputs, result envelopes, records and immediate related results. Type names also identify relationships to other topics; consult those topics for their workflows. Scalar names such as OrderID, ISO8601 and CurrencyISO describe the expected identifier, date-time or currency value.
BindingSide
LEFT, RIGHT, TOP
BindingType
SADDLE_STITCH, PERFECT_BOUND, CASE_BOUND, WIRE_BOUND, FLATWORK, FOLDED, OTHER
BoolFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
Boolean |
— | — |
CalculateImpositionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
componentId |
ComponentID! |
— | — |
mode |
ImposingMode |
— | — |
bindingSide |
BindingSide |
— | — |
bindingType |
BindingType |
— | — |
substrateIds |
[String!] |
— | — |
permittedFolds |
[String!] |
— | — |
maxPagesUp |
Int |
— | — |
scheme |
ImpositionScheme |
— | — |
gutterH |
LengthInput |
— | — |
gutterV |
LengthInput |
— | — |
gripEdge |
LengthInput |
— | — |
tailEdge |
LengthInput |
— | — |
sideMargin |
LengthInput |
— | — |
gangingRows |
Int |
— | — |
gangingCols |
Int |
— | — |
webPressProfile |
WebPressProfileInput |
— | — |
wasteWeight |
Float |
— | — |
utilisationWeight |
Float |
— | — |
sigCountWeight |
Float |
— | — |
foldUniformityWeight |
Float |
— | — |
selectPlanIndex |
Int |
— | — |
replaceExisting |
Boolean |
— | — |
CalculateImpositionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
plans |
[ImposingPlan!]! |
— | — |
gangingPlans |
[GangingPlan!]! |
— | — |
webPlans |
[WebImposingPlan!]! |
— | — |
recommendedIndex |
Int! |
— | — |
createdSpecs |
[ImpositionSpecState!]! |
— | — |
errors |
[FieldError!]! |
— | — |
CancelExecutionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
execution |
WorkflowExecutionState |
— | — |
errors |
[FieldError!]! |
— | — |
ColorSpaceInventoryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
ColorSpaceKind! |
— | — |
name |
String |
— | — |
alternate |
String |
— | — |
components |
Int! |
— | — |
ColorSpaceKind
DEVICE_GRAY, DEVICE_RGB, DEVICE_CMYK, SEPARATION, DEVICE_N, INDEXED, ICC_BASED, LAB
CommercialKind
BANNER, BROCHURE, BUSINESS_CARD, CATALOG, COMPLIMENT_SLIP, ENVELOPE, HARDCOVER_BOOK, LABEL, LETTERHEAD, MAGAZINE, POSTCARD, SOFTCOVER_BOOK, OTHER
CompleteFileUploadInput
| Field | Type | Default | Arguments |
|---|---|---|---|
fileId |
FileID! |
— | — |
checksum |
String |
— | — |
CompleteFileUploadsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
files |
[FileState!]! |
— | — |
errors |
[FieldError!]! |
— | — |
ComponentArtworkFileState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ComponentArtworkFileID! |
— | — |
componentId |
ComponentID! |
— | — |
fileId |
FileID |
— | — |
externalUri |
String |
— | — |
usageRole |
ComponentFileUsageRole! |
— | — |
description |
String |
— | — |
pageCount |
Int |
— | — |
pageRange |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
file |
FileState |
— | — |
component |
ComponentState |
— | — |
ComponentColorInfo
| Field | Type | Default | Arguments |
|---|---|---|---|
front |
ColorSide |
— | — |
back |
ColorSide |
— | — |
frontColorCount |
Int! |
— | — |
backColorCount |
Int! |
— | — |
ComponentFileUsageRole
ARTWORK, TEMPLATE, DATA, PATH, OTHER
ComponentGroupKind
TEXT_BLOCK, CASE, ENDPAPER, INSERT, OTHER
ComponentGroupState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ComponentGroupID! |
— | — |
jobId |
JobID! |
— | — |
name |
String! |
— | — |
kind |
ComponentGroupKind! |
— | — |
description |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
job |
JobState |
— | — |
components |
[ComponentState!]! |
— | — |
operations |
[OperationState!]! |
— | — |
totalPageCount |
Int |
— | — |
ComponentKind
CONTENT, COVER, INSERT, MAIN, TEXT, DUST_JACKET, ENDPAPER, OUTSERT, OTHER
ComponentLayout
| Field | Type | Default | Arguments |
|---|---|---|---|
substrate |
LayoutDimension |
— | — |
trimBox |
LayoutBox |
— | — |
bleed |
BleedSpec |
— | — |
bleedBox |
LayoutBox |
— | — |
safeBox |
LayoutBox |
— | — |
layers |
[LayoutLayer!]! |
— | — |
allowance |
LayoutAllowance |
— | — |
ComponentState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ComponentID! |
— | — |
jobId |
JobID! |
— | — |
componentGroupId |
ComponentGroupID |
— | — |
componentNumber |
String |
— | — |
externalId |
String |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
kind |
ComponentKind! |
— | — |
quantity |
Int! |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
job |
JobState |
— | — |
componentGroup |
ComponentGroupState |
— | — |
operations |
[OperationState!]! |
— | — |
milestones |
[MilestoneState!]! |
— | — |
totalPages |
Int |
— | — |
colors |
ComponentColorInfo |
— | — |
layout |
ComponentLayout |
— | — |
media |
Media |
— | — |
finishedSize |
Media |
— | — |
finishing |
FinishingSpec |
— | — |
desiredSubstrateId |
SubstrateID |
— | — |
actualSubstrateId |
SubstrateID |
— | — |
artworkFiles |
[ComponentArtworkFileState!]! |
— | — |
impositionSpecs |
[ImpositionSpecState!]! |
— | — |
prepressOperations |
[PrepressOperationState!]! |
— | — |
preflightReports |
[PreflightReportState!]! |
— | — |
desiredSubstrate |
SubstrateState |
— | — |
actualSubstrate |
SubstrateState |
— | — |
ConcurrencyPolicy
ALLOW, QUEUE, SKIP, CANCEL
ConformanceVerdict
| Field | Type | Default | Arguments |
|---|---|---|---|
validated |
PdfXStandard! |
— | — |
conformant |
Boolean! |
— | — |
declaredVersion |
String |
— | — |
declaredStandard |
PdfXStandard |
— | — |
ConformanceVerdictInput
| Field | Type | Default | Arguments |
|---|---|---|---|
validated |
PdfXStandard! |
— | — |
conformant |
Boolean! |
— | — |
declaredVersion |
String |
— | — |
declaredStandard |
PdfXStandard |
— | — |
ConsolidateFinishingInput
| Field | Type | Default | Arguments |
|---|---|---|---|
impositionSpecId |
ImpositionSpecID |
— | — |
layoutJSON |
String |
— | — |
ConsolidateFinishingPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
layers |
[LayoutLayer!]! |
— | — |
errors |
[String!]! |
— | — |
CreateFileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderId |
OrderID |
— | — |
estimateId |
EstimateID |
— | — |
invoiceId |
InvoiceID |
— | — |
purchaseOrderId |
PurchaseOrderID |
— | — |
name |
String! |
— | — |
originalFilename |
String! |
— | — |
mimeType |
String! |
— | — |
sizeBytes |
Int! |
— | — |
externalStorageKey |
String! |
— | — |
checksum |
String |
— | — |
category |
FileCategory! |
— | — |
status |
FileStatus |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
parentFileId |
FileID |
— | — |
versionNumber |
Int |
— | — |
processingMetadata |
JSONMap |
— | — |
uploadedByUserId |
UserID |
— | — |
CreateFolderInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
description |
String |
— | — |
kind |
FolderBindingKind! |
— | — |
storageBackendId |
StorageBackendID |
— | — |
controllerId |
ControllerID |
— | — |
rootPath |
String |
— | — |
isDefault |
Boolean |
— | — |
CreateFTPBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
host |
String! |
— | — |
port |
Int |
— | — |
username |
String! |
— | — |
password |
String! |
— | — |
rootPath |
String |
— | — |
passiveMode |
Boolean |
— | — |
CreateS3BackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
endpoint |
String! |
— | — |
region |
String! |
— | — |
bucket |
String! |
— | — |
pathStyle |
Boolean |
— | — |
accessKeyId |
String! |
— | — |
secretAccessKey |
String! |
— | — |
CreateStorageBackendAuthorizationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
provider |
StorageBackendOAuthProvider! |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
CreateStorageBackendAuthorizationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
resource |
StorageBackendAuthorizationOutput |
— | — |
errors |
[FieldError!]! |
— | — |
CreateStorageBackendConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
s3 |
CreateS3BackendInput |
— | — |
hostPath |
HostPathBackendInput |
— | — |
ftp |
CreateFTPBackendInput |
— | — |
CreateStorageBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
description |
String |
— | — |
config |
CreateStorageBackendConfigInput! |
— | — |
CreateSubstrateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
externalId |
String |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
externalCode |
String |
— | — |
supplierCode |
String |
— | — |
supplierId |
SupplierID |
— | — |
manufacturer |
String |
— | — |
brand |
String |
— | — |
kind |
MediaKind |
— | — |
mediaType |
MediaType |
— | — |
isoPaperSubstrate |
ISOPaperSubstrate |
— | — |
width |
LengthInput |
— | — |
height |
LengthInput |
— | — |
weight |
PaperWeightInput |
— | — |
thickness |
LengthInput |
— | — |
coatings |
[MediaCoating!] |
— | — |
grainDirection |
MediaGrainDirection |
— | — |
imageableSide |
MediaImageableSide |
— | — |
opacity |
MediaOpacity |
— | — |
printingTechnology |
MediaPrintingTechnology |
— | — |
stockType |
MediaStockType |
— | — |
texture |
MediaTexture |
— | — |
color |
MediaColor |
— | — |
preAppliedCoatings |
[MediaCoating!] |
— | — |
shrinkIndex |
[Float!] |
— | — |
brightness |
Float |
— | — |
cieWhiteness |
Float |
— | — |
grade |
Int |
— | — |
fluteType |
MediaFluteType |
— | — |
recycledPercentage |
Float |
— | — |
buyerSupplied |
Boolean |
— | — |
moisture |
Float |
— | — |
supplierLeadTimeDays |
Int |
— | — |
isActive |
Boolean |
— | — |
reorderThreshold |
Float |
— | — |
reorderUnit |
MeasurementUnit |
— | — |
unitCost |
Float |
— | — |
costCurrency |
CurrencyISO |
— | — |
notes |
String |
— | — |
CreateSubstrateTemplateLineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
productTemplateId |
ProductTemplateID! |
— | — |
componentLocalId |
String |
— | — |
substrateId |
SubstrateID! |
— | — |
quantityPer100 |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
wasteFactor |
Float |
— | — |
notes |
String |
— | — |
CreateTemplateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
handle |
String! |
— | — |
kind |
TemplateKind |
— | — |
content |
String! |
— | — |
description |
String |
— | — |
CreateWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
description |
String |
— | — |
isActive |
Boolean |
— | — |
botUserId |
UserID |
— | — |
defaultNodeTimeoutSeconds |
Int |
— | — |
CreateWorkflowTriggerInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
versionId |
WorkflowVersionID |
— | — |
name |
String! |
— | — |
config |
TriggerConfigInput! |
— | — |
isEnabled |
Boolean |
— | — |
concurrencyPolicy |
ConcurrencyPolicy |
— | — |
maxConcurrentExecutions |
Int |
— | — |
CreateWorkflowVersionFromSourceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
sourceXML |
String! |
— | — |
CreateWorkflowVersionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
definition |
WorkflowDefinitionInput |
— | — |
sourceXML |
String |
— | — |
DateFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
ISO8601 |
— | — |
neq |
ISO8601 |
— | — |
gt |
ISO8601 |
— | — |
gte |
ISO8601 |
— | — |
lt |
ISO8601 |
— | — |
lte |
ISO8601 |
— | — |
DeleteComponentArtworkFileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ComponentArtworkFileID! |
— | — |
DeleteComponentArtworkFilePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeleteImpositionSpecInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ImpositionSpecID! |
— | — |
DeleteImpositionSpecPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeletePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeletePreflightReportInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PreflightReportID! |
— | — |
DeletePreflightReportPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeletePrepressOperationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PrepressOperationID! |
— | — |
DeletePrepressOperationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeleteTemplatePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeleteWorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
DeleteWorkflowTriggerInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowTriggerID! |
— | — |
DeviceMQTTTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
topic |
String! |
— | — |
deviceId |
String |
— | — |
filter |
String |
— | — |
Dictionary
| Field | Type | Default | Arguments |
|---|---|---|---|
key |
String! |
— | — |
value |
String! |
— | — |
DictionaryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
key |
String! |
— | — |
value |
String! |
— | — |
DisableWorkflowTriggerInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowTriggerID! |
— | — |
DocumentCompressionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
dataFormat |
String! |
— | — |
isCompressed |
Boolean! |
— | — |
filters |
[String!]! |
— | — |
DocumentInventory
| Field | Type | Default | Arguments |
|---|---|---|---|
metadata |
DocumentMetadata! |
— | — |
security |
DocumentSecurity! |
— | — |
compression |
DocumentCompression! |
— | — |
outputIntent |
OutputIntentInfo |
— | — |
pages |
[PageInventory!]! |
— | — |
fonts |
[FontInventory!]! |
— | — |
images |
[ImageInventory!]! |
— | — |
colorSpaces |
[ColorSpaceInventory!]! |
— | — |
spotColors |
[String!]! |
— | — |
layers |
[String!]! |
— | — |
pageColorSummary |
PageColorSummary! |
— | — |
production |
ProductionFlags! |
— | — |
ink |
InkSummary |
— | — |
opiLinks |
Int! |
— | — |
DocumentInventoryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
metadata |
DocumentMetadataInput! |
— | — |
security |
DocumentSecurityInput! |
— | — |
compression |
DocumentCompressionInput! |
— | — |
outputIntent |
OutputIntentInfoInput |
— | — |
pages |
[PageInventoryInput!]! |
— | — |
fonts |
[FontInventoryInput!]! |
— | — |
images |
[ImageInventoryInput!]! |
— | — |
colorSpaces |
[ColorSpaceInventoryInput!]! |
— | — |
spotColors |
[String!]! |
— | — |
layers |
[String!]! |
— | — |
pageColorSummary |
PageColorSummaryInput! |
— | — |
production |
ProductionFlagsInput! |
— | — |
ink |
InkSummaryInput |
— | — |
opiLinks |
Int! |
— | — |
DocumentMetadataInput
| Field | Type | Default | Arguments |
|---|---|---|---|
title |
String |
— | — |
author |
String |
— | — |
subject |
String |
— | — |
keywords |
String |
— | — |
creator |
String |
— | — |
producer |
String |
— | — |
creationDate |
String |
— | — |
modificationDate |
String |
— | — |
pdfVersion |
String! |
— | — |
pageCount |
Int! |
— | — |
trapped |
Boolean |
— | — |
linearized |
Boolean! |
— | — |
containsThumbnails |
Boolean! |
— | — |
DocumentSecurityInput
| Field | Type | Default | Arguments |
|---|---|---|---|
encryption |
String! |
— | — |
permissions |
PermissionsInput! |
— | — |
DropboxBackend
| Field | Type | Default | Arguments |
|---|---|---|---|
hasCredentials |
Boolean! |
— | — |
expiresAt |
String! |
— | — |
EdgeAppEventTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
controllerId |
String |
— | — |
edgeAppHandle |
String |
— | — |
topic |
String |
— | — |
EnableWorkflowTriggerInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowTriggerID! |
— | — |
EventTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
topic |
String! |
— | — |
filter |
String |
— | — |
dataQuery |
String |
— | — |
ExecuteWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
versionId |
WorkflowVersionID |
— | — |
input |
String |
— | — |
triggerType |
String |
— | — |
ExecuteWorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
execution |
WorkflowExecutionState |
— | — |
errors |
[FieldError!]! |
— | — |
ExecutionLogConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ExecutionLogEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ExecutionLogContextType
INTEGRATION_INSTANCE, WORKFLOW_EXECUTION
ExecutionLogEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ExecutionLogState! |
— | — |
cursor |
String! |
— | — |
ExecutionLogLevel
INFO, WARNING, ERROR
ExecutionLogState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ExecutionLogID! |
— | — |
level |
ExecutionLogLevel! |
— | — |
message |
String! |
— | — |
metadata |
String |
— | — |
createdAt |
ISO8601! |
— | — |
ExecutionStatus
PENDING, RUNNING, COMPLETED, FAILED, WAITING, CANCELLED
ExportWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
versionId |
WorkflowVersionID! |
— | — |
format |
WorkflowSerializationFormat! |
— | — |
ExportWorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
content |
String |
— | — |
format |
WorkflowSerializationFormat |
— | — |
errors |
[FieldError!]! |
— | — |
ExpressionDiagnosticSeverity
ERROR, WARNING
ExpressionFormat
PREDICATE, TEMPLATE
ExternalRefInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobExternalId |
String |
— | — |
componentExternalId |
String |
— | — |
operationExternalId |
String |
— | — |
itemExternalId |
String |
— | — |
ExtractProductionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
pdfBytes |
BinaryBase64! |
— | — |
ExtractProductionOperationsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
artworkFileId |
ComponentArtworkFileID! |
— | — |
createOperations |
Boolean |
— | — |
ExtractProductionOperationsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
operations |
[OperationState!]! |
— | — |
created |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
ExtractProductionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
intent |
ProductionIntent |
— | — |
errors |
[FieldError!]! |
— | — |
FieldError
| Field | Type | Default | Arguments |
|---|---|---|---|
code |
String |
— | — |
source |
SourceDiagnostic |
— | — |
path |
String! |
— | — |
message |
String! |
— | — |
FileCategory
ARTWORK, PREPRESS, IMPOSITION, PROOF, PRODUCTION_OUTPUT, QUALITY_REPORT, INVOICE, DELIVERY_NOTE, PURCHASE_ORDER, SUBSTRATE, OTHER
FileConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[FileEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
FileDownloadGrant
| Field | Type | Default | Arguments |
|---|---|---|---|
url |
String! |
— | — |
expiresAt |
String |
— | — |
kind |
FileDownloadKind! |
— | — |
FileDownloadKind
PRESIGNED, EXTERNAL, AUTHENTICATED
FileEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
FileState! |
— | — |
cursor |
String! |
— | — |
FileFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
category |
StringFilter |
— | — |
status |
FileStatusFilter |
— | — |
jobId |
IDFilter |
— | — |
FileSortField
NAME, CATEGORY, STATUS, SIZE_BYTES, CREATED_AT
FileSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
FileSortField! |
— | — |
direction |
SortDirection! |
— | — |
FileState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
FileID! |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderId |
OrderID |
— | — |
estimateId |
EstimateID |
— | — |
invoiceId |
InvoiceID |
— | — |
purchaseOrderId |
PurchaseOrderID |
— | — |
name |
String! |
— | — |
originalFilename |
String! |
— | — |
mimeType |
String! |
— | — |
sizeBytes |
Int! |
— | — |
storageBackend |
FileStorageBackendTag |
— | — |
folderId |
FolderID |
— | — |
externalStorageKey |
String |
— | — |
checksum |
String |
— | — |
category |
FileCategory! |
— | — |
status |
FileStatus! |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
parentFileId |
FileID |
— | — |
versionNumber |
Int! |
— | — |
processingMetadata |
JSONMap |
— | — |
uploadedByUserId |
UserID |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
FileStatus
UPLOADING, PROCESSING, READY, FAILED, ARCHIVED
FileStatusFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
FileStatus |
— | — |
neq |
FileStatus |
— | — |
in |
[FileStatus!] |
— | — |
notIn |
[FileStatus!] |
— | — |
FileStorageBackendTag
FOLDER, EXTERNAL
FileUploadGrant
| Field | Type | Default | Arguments |
|---|---|---|---|
fileId |
FileID! |
— | — |
uploadUrl |
String! |
— | — |
expiresAt |
String |
— | — |
FinishingSpec
| Field | Type | Default | Arguments |
|---|---|---|---|
varnishType |
String |
— | — |
dieType |
String |
— | — |
foilColor |
PrintColor |
— | — |
embossType |
String |
— | — |
depth |
Length |
— | — |
FoldCatalogPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
patterns |
[FoldPattern!]! |
— | — |
Folder
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
FolderID! |
— | — |
tenantId |
TenantID! |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
kind |
FolderBindingKind! |
— | — |
storageBackendId |
StorageBackendID |
— | — |
controllerId |
ControllerID |
— | — |
rootPath |
String! |
— | — |
isDefault |
Boolean! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
FolderBindingKind
CONTROL_CLOUD, STORAGE_BACKEND, CONTROLLER
FolderConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[FolderEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
FolderEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
Folder! |
— | — |
cursor |
String! |
— | — |
FolderFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
kind |
FolderBindingKind |
— | — |
FolderPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
folder |
Folder |
— | — |
errors |
[FieldError!]! |
— | — |
FolderProbeResult
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
FolderProbeStatus! |
— | — |
ok |
Boolean! |
— | — |
error |
String |
— | — |
FolderProbeStatus
REACHABLE, UNAVAILABLE, UNKNOWN
FolderSortField
NAME, CREATED_AT, UPDATED_AT
FolderSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
FolderSortField! |
— | — |
direction |
SortDirection! |
— | — |
FolderWatchTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
folderId |
FolderID! |
— | — |
prefix |
String! |
— | — |
FoldLine
| Field | Type | Default | Arguments |
|---|---|---|---|
axis |
SheetLineAxis! |
— | — |
position |
Length! |
— | — |
FoldPattern
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
name |
String! |
— | — |
pagesPerSection |
Int! |
— | — |
foldsRequired |
Int! |
— | — |
isWebCompatible |
Boolean! |
— | — |
maxSheetThickness |
Length |
— | — |
FontInventoryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
subtype |
String! |
— | — |
encoding |
String |
— | — |
embedded |
Boolean! |
— | — |
subset |
Boolean! |
— | — |
openTypeEmbedded |
Boolean! |
— | — |
usedOnPages |
[Int!]! |
— | — |
FTPBackend
| Field | Type | Default | Arguments |
|---|---|---|---|
host |
String! |
— | — |
port |
Int! |
— | — |
username |
String! |
— | — |
rootPath |
String! |
— | — |
passiveMode |
Boolean! |
— | — |
hasCredentials |
Boolean! |
— | — |
credentialsUpdatedAt |
String |
— | — |
FTPBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
host |
String |
— | — |
port |
Int |
— | — |
username |
String |
— | — |
password |
String |
— | — |
rootPath |
String |
— | — |
passiveMode |
Boolean |
— | — |
GangingPlan
| Field | Type | Default | Arguments |
|---|---|---|---|
rows |
Int! |
— | — |
cols |
Int! |
— | — |
pagesUp |
Int! |
— | — |
sheetsRequired |
Int! |
— | — |
substrate |
SubstrateInput! |
— | — |
orientation |
ImpositionOrientation! |
— | — |
utilisation |
Float! |
— | — |
gutterH |
Length! |
— | — |
gutterV |
Length! |
— | — |
layout |
SheetLayout! |
— | — |
GoogleDriveBackend
| Field | Type | Default | Arguments |
|---|---|---|---|
hasCredentials |
Boolean! |
— | — |
expiresAt |
String! |
— | — |
rootFolderId |
String |
— | — |
HostPathBackend
| Field | Type | Default | Arguments |
|---|---|---|---|
path |
String! |
— | — |
HostPathBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
path |
String! |
— | — |
IDFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
ID |
— | — |
neq |
ID |
— | — |
in |
[ID!] |
— | — |
notIn |
[ID!] |
— | — |
ImageInventoryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
imageType |
ImageKind! |
— | — |
colorSpace |
String! |
— | — |
pixelWidth |
Int! |
— | — |
pixelHeight |
Int! |
— | — |
effectiveDPIH |
Float! |
— | — |
effectiveDPIV |
Float! |
— | — |
bitsPerChannel |
Int! |
— | — |
angleDegrees |
Float! |
— | — |
skewed |
Boolean! |
— | — |
flipped |
Boolean! |
— | — |
page |
Int! |
— | — |
bbox |
PreflightBoundingBoxInput! |
— | — |
ImageKind
COLOR, GRAYSCALE, MONOCHROME, INDEXED
ImportWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
content |
String! |
— | — |
format |
WorkflowSerializationFormat! |
— | — |
validate |
Boolean |
— | — |
ImportWorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
version |
WorkflowVersionState |
— | — |
errors |
[FieldError!]! |
— | — |
ImposePdfInlineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
planJSON |
String! |
— | — |
pdfBytes |
BinaryBase64! |
— | — |
ImposePdfInlinePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
pdfBytes |
BinaryBase64 |
— | — |
contentType |
String |
— | — |
renderedSides |
Int! |
— | — |
renderedPlacements |
Int! |
— | — |
diagnostics |
[String!]! |
— | — |
diagnosticsTruncated |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
ImposingMode
SIGNATURE, GANGING, WEB
ImposingObjectives
| Field | Type | Default | Arguments |
|---|---|---|---|
waste |
Float! |
— | — |
utilisation |
Float! |
— | — |
signatureCount |
Float! |
— | — |
foldUniformity |
Float! |
— | — |
ImposingPlan
| Field | Type | Default | Arguments |
|---|---|---|---|
renderPlanJSON |
String! |
— | — |
signatures |
[SignatureResult!]! |
— | — |
sheetsPerCopy |
Int! |
— | — |
totalForms |
Int! |
— | — |
copiesPerSheet |
Int! |
— | — |
totalSheets |
Int |
— | — |
wastePages |
Int! |
— | — |
substrate |
SubstrateInput! |
— | — |
objectives |
ImposingObjectives! |
— | — |
layout |
SheetLayout! |
— | — |
ImposingSettings
| Field | Type | Default | Arguments |
|---|---|---|---|
gutter |
Length! |
— | — |
gripEdge |
Length! |
— | — |
bleed |
Length! |
— | — |
trimTolerance |
Length |
— | — |
lastChange |
SettingsChange |
— | — |
ImposingSettingsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
gutter |
LengthInput! |
— | — |
gripEdge |
LengthInput! |
— | — |
bleed |
LengthInput! |
— | — |
trimTolerance |
LengthInput |
— | — |
ImpositionLayoutStatus
ENGINE, SYNTHESIZED, PROVISIONAL, NONE
ImpositionOrientation
PORTRAIT, LANDSCAPE, BEST_FIT
ImpositionScheme
WORK_AND_TURN, WORK_AND_TUMBLE, SHEETWISE, WEB_PERFECT, OTHER
ImpositionSpecState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ImpositionSpecID! |
— | — |
componentId |
ComponentID! |
— | — |
name |
String |
— | — |
description |
String |
— | — |
isPrimary |
Boolean! |
— | — |
pagesUp |
Int |
— | — |
sheetsPerForm |
Int |
— | — |
totalForms |
Int |
— | — |
totalPages |
Int |
— | — |
scheme |
ImpositionScheme |
— | — |
orientation |
ImpositionOrientation |
— | — |
bindingType |
BindingType |
— | — |
gutterH |
Length |
— | — |
gutterV |
Length |
— | — |
layout |
SheetLayout |
— | — |
layoutStatus |
ImpositionLayoutStatus! |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
component |
ComponentState |
— | — |
InkSummaryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
meanTACPercent |
Float! |
— | — |
maxTACPercent |
Float! |
— | — |
maxTACPage |
Int! |
— | — |
ISOPaperSubstrate
PS1, PS2, PS3, PS4, PS5, PS6, PS7, PS8
JinjaDiagnostic
| Field | Type | Default | Arguments |
|---|---|---|---|
line |
Int! |
— | — |
column |
Int! |
— | — |
offset |
Int! |
— | — |
severity |
ExpressionDiagnosticSeverity! |
— | — |
message |
String! |
— | — |
phase |
String! |
— | — |
JobState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
JobID! |
— | — |
name |
String! |
— | — |
quantity |
Int! |
— | — |
dueAt |
ISO8601 |
— | — |
status |
JobStatus! |
— | — |
jobNumber |
String |
— | — |
externalId |
String |
— | — |
description |
String |
— | — |
maxDeliverableQuantity |
Int |
— | — |
tags |
[String!] |
— | — |
billingCustomerId |
CustomerID |
— | — |
deliveryCustomerId |
CustomerID |
— | — |
estimateId |
EstimateID |
— | — |
sourceTemplateId |
String |
— | — |
sourceTemplateVersion |
Int |
— | — |
jobGroupId |
JobGroupID |
— | — |
priority |
Int! |
— | — |
scheduledStartAt |
ISO8601 |
— | — |
scheduledEndAt |
ISO8601 |
— | — |
actualStartAt |
ISO8601 |
— | — |
actualEndAt |
ISO8601 |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
components |
[ComponentState!]! |
— | — |
operations |
[OperationState!]! |
— | — |
milestones |
[MilestoneState!]! |
— | — |
billingCustomer |
CustomerState |
— | — |
deliveryCustomer |
CustomerState |
— | — |
estimate |
EstimateState |
— | — |
productionKind |
ProductionKind |
— | — |
commercialKind |
CommercialKind |
— | — |
JobStatus
DRAFT, RFQ, CONFIRMED, PREPRESS, PRESS, POSTPRESS, PACKING, SHIPPED, COMPLETED, WAITING, CANCELLED, EXCEPTION
LayerBoundary
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
LayerBoundaryKind! |
— | — |
rect |
LayoutBox |
— | — |
path |
String |
— | — |
LayerBoundaryKind
RECT, PATH
LayerFinishing
| Field | Type | Default | Arguments |
|---|---|---|---|
coatingType |
String |
— | — |
color |
String |
— | — |
depth |
Float |
— | — |
LayerPlacement
| Field | Type | Default | Arguments |
|---|---|---|---|
a |
Float! |
— | — |
b |
Float! |
— | — |
c |
Float! |
— | — |
d |
Float! |
— | — |
e |
Float! |
— | — |
f |
Float! |
— | — |
LayoutLayer
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
name |
String! |
— | — |
kind |
LayoutLayerKind! |
— | — |
boundary |
LayerBoundary! |
— | — |
finishing |
LayerFinishing |
— | — |
marks |
[LayoutMark!]! |
— | — |
printable |
Boolean! |
— | — |
sortOrder |
Int! |
— | — |
placement |
LayerPlacement |
— | — |
LayoutLayerKind
CONTENT, MARKS, WHITE_UNDERPRINT, DIE_CUT, KISS_CUT, REVERSE_CUT, PARTIAL_CUT, CREASE, PERFORATION, SPOT_VARNISH, FLOOD_VARNISH, LAMINATE, FOIL, EMBOSS, DEBOSS, FOLD, DRILL, PUNCH, GLUE, EYELETS, HEMMING, OTHER
LayoutMark
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
MarkKind! |
— | — |
boundary |
LayerBoundary! |
— | — |
angle |
Float |
— | — |
LayoutUnit
MM, PT, IN
Length
| Field | Type | Default | Arguments |
|---|---|---|---|
raw |
Float! |
— | — |
unit |
LengthUnit! |
— | — |
micrometers |
Float! |
— | — |
millimeters |
Float! |
— | — |
centimeters |
Float! |
— | — |
inches |
Float! |
— | — |
points |
Float! |
— | — |
value |
Float! |
— | unit: LengthUnit! |
LengthInput
| Field | Type | Default | Arguments |
|---|---|---|---|
value |
Float! |
— | — |
unit |
LengthUnit! |
— | — |
LengthUnit
UM, MM, CM, IN, PT
MarkKind
REGISTRATION, COLOR_BAR, TRIM_MARK, FOLD_MARK, CUT_MARK, BLEED_MARK, SAFETY_LINE, BARCODE, EYE_MARK
MeasurementUnit
CLICK, CM, FT, G, IMPRESSION, IN, KG, LB, M, MM, OZ, PC, PT, SHEET
Media
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
kind |
MediaKind |
— | — |
width |
Length |
— | — |
height |
Length |
— | — |
weight |
PaperWeight |
— | — |
thickness |
Length |
— | — |
coating |
MediaCoating |
— | — |
grainDirection |
MediaGrainDirection |
— | — |
imageableSide |
MediaImageableSide |
— | — |
opacity |
MediaOpacity |
— | — |
printingTechnology |
MediaPrintingTechnology |
— | — |
stockType |
MediaStockType |
— | — |
texture |
MediaTexture |
— | — |
stock |
String |
— | — |
MediaCoating
COATED, HIGH_GLOSS, GLOSSY, MATTE, NONE, SATIN, SEMIGLOSS
MediaColor
WHITE, BUFF, PINK, YELLOW, BLUE, GREEN, GOLDENROD, IVORY, ORANGE, RED, CREAM, GRAY, TAN, TRANSPARENT, OTHER
MediaFluteType
A, B, C, E, F, N, BC, EB, MICRO
MediaGrainDirection
ANY, LONG, SHORT
MediaImageableSide
FRONT, BACK, BOTH, NEITHER
MediaKind
ROLL, SHEET
MediaOpacity
OPAQUE, TRANSLUCENT, TRANSPARENT
MediaPrintingTechnology
DYE_SUBLIMATION, ELECTROSTATIC, FLEXO, GRAVURE, INKJET, LASER, LETTERPRESS, OFFSET, SCREEN, THERMAL
MediaStockType
BIBLE, BOND, BOOK, BRISTOL, COATED, COVER, INDEX, LEDGER, MANIFOLD, NEWSPRINT, OFFSET, TAG, TEXT
MediaTexture
ANTIQUE, GLOSSY, LINEN, MATTE, SMOOTH, VELLUM
MediaType
BLANKET, CORRUGATED_BOARD, DISC, END_BOARD, EMBOSSING_FOIL, FILM, FOIL, GRAVURE_CYLINDER, IMAGING_CYLINDER, LAMINATING_FOIL, MOUNTING_TAPE, PAPER, PLATE, SCREEN, SELF_ADHESIVE, SHRINK_FOIL, SLEEVE, SYNTHETIC, TEXTILE, TRANSPARENCY, OTHER
MetricUnit
NONE, PERCENT, RATIO, BOOLEAN, COUNT, PIECES, MILLIMETERS, METERS, INCHES, FEET, METERS_PER_MINUTE, FEET_PER_MINUTE, UNITS_PER_MINUTE, UNITS_PER_HOUR, CELSIUS, FAHRENHEIT, KELVIN, BAR, PSI, KILOPASCAL, GRAMS, KILOGRAMS, POUNDS, MILLILITERS, LITERS, SQUARE_METERS, SQUARE_FEET, MILLISECONDS, SECONDS, MINUTES, HOURS, VOLTS, AMPS, WATTS, KILOWATT_HOURS, BYTES, KILOBYTES, MEGABYTES, CUSTOM
MilestoneState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
MilestoneID! |
— | — |
jobId |
JobID! |
— | — |
componentId |
ComponentID |
— | — |
externalId |
String |
— | — |
externalStartId |
String |
— | — |
externalCompletionId |
String |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
startDueAt |
ISO8601 |
— | — |
startedAt |
ISO8601 |
— | — |
dueAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
cancelledAt |
ISO8601 |
— | — |
cancelReason |
String |
— | — |
isStarted |
Boolean! |
— | — |
isCompleted |
Boolean! |
— | — |
isCancelled |
Boolean! |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
job |
JobState |
— | — |
component |
ComponentState |
— | — |
NodeOutputSchemaDiagnosticSeverity
INFO, WARNING, ERROR
NodeOutputSchemaPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
schema |
JSON |
— | — |
resolution |
NodeOutputSchemaResolution |
— | — |
diagnostics |
[NodeSchemaDiagnostic!]! |
— | — |
errors |
[FieldError!]! |
— | — |
NodeOutputSchemaResolution
INFERRED, INTROSPECTED, STATIC, PASSTHROUGH
NodeSchemaDiagnostic
| Field | Type | Default | Arguments |
|---|---|---|---|
severity |
NodeOutputSchemaDiagnosticSeverity! |
— | — |
message |
String! |
— | — |
line |
Int |
— | — |
OperationExecutionAllocation
| Field | Type | Default | Arguments |
|---|---|---|---|
allocationId |
ScheduleAllocationID! |
— | — |
scenarioId |
ScheduleScenarioID! |
— | — |
workCenterId |
WorkCenterID! |
— | — |
workCenterName |
String! |
— | — |
plannedOperationId |
PlannedOperationID |
— | — |
plannedStartAt |
ISO8601! |
— | — |
plannedEndAt |
ISO8601! |
— | — |
setupStartedAt |
ISO8601! |
— | — |
capabilityCode |
String |
— | — |
resolvedParameters |
JSON |
— | — |
OperationItemState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
OperationItemID! |
— | — |
operationId |
OperationID! |
— | — |
jobId |
JobID! |
— | — |
externalId |
String |
— | — |
label |
String! |
— | — |
sortOrder |
Int! |
— | — |
status |
OperationItemStatus! |
— | — |
workCenterId |
WorkCenterID |
— | — |
parameters |
JSON |
— | — |
estimatedDurationMinutes |
Int |
— | — |
scheduledStartAt |
ISO8601 |
— | — |
actualStartAt |
ISO8601 |
— | — |
scheduledCompletionAt |
ISO8601 |
— | — |
actualCompletionAt |
ISO8601 |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
operation |
OperationState |
— | — |
workCenter |
WorkCenterState |
— | — |
OperationItemStatus
PENDING, AVAILABLE, RUNNING, COMPLETED, FAILED, CANCELLED
OperationKind
BINDING, BOOK_BLOCK_MAKING, COLLATING, COMB_BINDING, CONTOUR_CUTTING, CREASING, CUTTING, DEBOSSING, DIE_CUTTING, DIGITAL_PRINTING, DRILLING, EMBOSSING, FOIL_STAMPING, FOLDING, GLUING, HEAD_BANDING, INKJET_PRINTING, FLOOD_COATING, LAMINATING, OFFSET_PRINTING, PACKING, PERFECT_BINDING, PERFORATING, PRECUTTING, PRINTING, PUNCHING, RING_BINDING, SADDLE_STITCHING, SCORING, SEWING, SLITTING, SPIRAL_BINDING, STITCHING, STRIP_BINDING, CASE_MAKING, CASING_IN, CUSTOM, DRYING, ENDPAPER_TIPPING, EYELETS, HEMMING, PLATEMAKING, ROUNDING_BACKING, SPINE_MILLING, SPOT_VARNISH, KISS_CUTTING, REVERSE_CUTTING, PARTIAL_CUTTING, WHITE_UNDERPRINT
OperationState
| Field | Type | Default | Arguments |
|---|---|---|---|
executionAllocation |
OperationExecutionAllocation |
— | — |
id |
OperationID! |
— | — |
jobId |
JobID! |
— | — |
componentId |
ComponentID |
— | — |
componentGroupId |
ComponentGroupID |
— | — |
milestoneId |
MilestoneID |
— | — |
externalId |
String |
— | — |
name |
String! |
— | — |
remarks |
String |
— | — |
kind |
OperationKind! |
— | — |
requiredResourceType |
String |
— | — |
capabilityId |
CapabilityID |
— | — |
requestedWorkCenterId |
WorkCenterID |
— | — |
status |
OperationStatus! |
— | — |
productionQuantity |
Int |
— | — |
expectedDuration |
Int |
— | — |
deadline |
ISO8601 |
— | — |
scheduledStartAt |
ISO8601 |
— | — |
actualStartAt |
ISO8601 |
— | — |
scheduledCompletionAt |
ISO8601 |
— | — |
actualCompletionAt |
ISO8601 |
— | — |
metadata |
JSONMap |
— | — |
parameters |
JSON |
— | — |
sortOrder |
Int! |
— | — |
outsourcedSupplierId |
SupplierID |
— | — |
outsourcedPurchaseOrderId |
PurchaseOrderID |
— | — |
outsourcedLeadTimeDays |
Int |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
job |
JobState |
— | — |
component |
ComponentState |
— | — |
componentGroup |
ComponentGroupState |
— | — |
milestone |
MilestoneState |
— | — |
requestedWorkCenter |
WorkCenterState |
— | — |
items |
[OperationItemState!]! |
— | — |
customKind |
String |
— | — |
OperationStatus
PENDING, AVAILABLE, SETUP, RUNNING, CLEANUP, COMPLETED, FAILED, STOPPED, CANCELLED, RESTARTING
OutputIntentInfoInput
| Field | Type | Default | Arguments |
|---|---|---|---|
subtype |
String! |
— | — |
outputCondition |
String |
— | — |
conditionIdentifier |
String |
— | — |
registryName |
String |
— | — |
destProfileName |
String |
— | — |
OverlapPolicy
ALLOW, SKIP, CANCEL
PageBoxInput
| Field | Type | Default | Arguments |
|---|---|---|---|
minX |
Float! |
— | — |
minY |
Float! |
— | — |
maxX |
Float! |
— | — |
maxY |
Float! |
— | — |
defined |
Boolean! |
— | — |
PageColor
EMPTY, BLACK_AND_WHITE, COLOR, UNKNOWN
PageColorSummaryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
emptyPages |
Int! |
— | — |
blackAndWhitePages |
Int! |
— | — |
colorPages |
Int! |
— | — |
PageInfo
| Field | Type | Default | Arguments |
|---|---|---|---|
hasNextPage |
Boolean! |
— | — |
hasPreviousPage |
Boolean! |
— | — |
startCursor |
String |
— | — |
endCursor |
String |
— | — |
PageInventoryInput
| Field | Type | Default | Arguments |
|---|---|---|---|
index |
Int! |
— | — |
rotation |
Int! |
— | — |
mediaBox |
PageBoxInput! |
— | — |
cropBox |
PageBoxInput! |
— | — |
trimBox |
PageBoxInput! |
— | — |
bleedBox |
PageBoxInput! |
— | — |
artBox |
PageBoxInput! |
— | — |
colorType |
PageColor! |
— | — |
PaperBasis
TEXT_BOOK, BOND, COVER, INDEX, TAG, BRISTOL, NEWSPRINT
PaperWeight
| Field | Type | Default | Arguments |
|---|---|---|---|
raw |
Float! |
— | — |
gsm |
Float! |
— | — |
value |
Float! |
— | unit: PaperWeightUnitInput! |
unit |
PaperWeightUnit! |
— | — |
shown |
PaperWeight! |
— | preference: PaperWeightUnitInput! |
PaperWeightInput
| Field | Type | Default | Arguments |
|---|---|---|---|
value |
Float! |
— | — |
unit |
PaperWeightUnitInput! |
— | — |
PaperWeightSettings
| Field | Type | Default | Arguments |
|---|---|---|---|
unit |
PaperWeightUnit! |
— | — |
lastChange |
SettingsChange |
— | — |
PaperWeightSettingsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
unit |
PaperWeightUnitInput! |
— | — |
PaperWeightUnit
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
PaperWeightUnitKind! |
— | — |
basis |
PaperBasis |
— | — |
PaperWeightUnitInput
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
PaperWeightUnitKind! |
— | — |
basis |
PaperBasis |
— | — |
PaperWeightUnitKind
GSM, POUNDS_AT_BASIS
PdfXStandard
X_1A, X_3, X_4
PermissionsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
printHighQuality |
Boolean! |
— | — |
printLowQuality |
Boolean! |
— | — |
modifyContents |
Boolean! |
— | — |
modifyAnnotations |
Boolean! |
— | — |
fillForms |
Boolean! |
— | — |
assemble |
Boolean! |
— | — |
extractContent |
Boolean! |
— | — |
extractAccessibility |
Boolean! |
— | — |
PlacedCell
| Field | Type | Default | Arguments |
|---|---|---|---|
index |
Int! |
— | — |
x |
Length! |
— | — |
y |
Length! |
— | — |
width |
Length! |
— | — |
height |
Length! |
— | — |
trimX |
Length! |
— | — |
trimY |
Length! |
— | — |
trimWidth |
Length! |
— | — |
trimHeight |
Length! |
— | — |
pageNumber |
Int |
— | — |
rotation |
Float! |
— | — |
isBlank |
Boolean! |
— | — |
PreflightBoundingBoxInput
| Field | Type | Default | Arguments |
|---|---|---|---|
minX |
Float! |
— | — |
minY |
Float! |
— | — |
maxX |
Float! |
— | — |
maxY |
Float! |
— | — |
PreflightCheckInput
| Field | Type | Default | Arguments |
|---|---|---|---|
pdfBytes |
BinaryBase64! |
— | — |
profile |
PreflightProfile |
— | — |
PreflightCheckPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
report |
PreflightReport |
— | — |
errors |
[FieldError!]! |
— | — |
PreflightIssue
| Field | Type | Default | Arguments |
|---|---|---|---|
rule |
PreflightRule! |
— | — |
severity |
PreflightSeverity! |
— | — |
page |
Int |
— | — |
boundingBox |
PreflightBoundingBox |
— | — |
message |
String! |
— | — |
suggestedFix |
String |
— | — |
value0 |
Float! |
— | — |
value1 |
Float! |
— | — |
PreflightIssueInput
| Field | Type | Default | Arguments |
|---|---|---|---|
rule |
PreflightRule! |
— | — |
severity |
PreflightSeverity! |
— | — |
page |
Int |
— | — |
boundingBox |
PreflightBoundingBoxInput |
— | — |
message |
String! |
— | — |
suggestedFix |
String |
— | — |
value0 |
Float! |
— | — |
value1 |
Float! |
— | — |
PreflightProfile
COMMERCIAL_OFFSET, PDF_X_1A, PDF_X_3, PDF_X_4, PDF_X_CLAIMED
PreflightReport
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
PreflightStatus! |
— | — |
pageCount |
Int! |
— | — |
fileSize |
String! |
— | — |
pagesAnalyzed |
Int! |
— | — |
pdfVersion |
String! |
— | — |
producer |
String! |
— | — |
profileUsed |
String! |
— | — |
passed |
Boolean! |
— | — |
issues |
[PreflightIssue!]! |
— | — |
inventory |
DocumentInventory! |
— | — |
provenance |
RunProvenance! |
— | — |
conformance |
ConformanceVerdict |
— | — |
PreflightReportInput
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
PreflightStatus! |
— | — |
pageCount |
Int! |
— | — |
fileSize |
Int! |
— | — |
pagesAnalyzed |
Int! |
— | — |
pdfVersion |
String! |
— | — |
producer |
String! |
— | — |
profileUsed |
String! |
— | — |
issues |
[PreflightIssueInput!]! |
— | — |
inventory |
DocumentInventoryInput! |
— | — |
provenance |
RunProvenanceInput! |
— | — |
conformance |
ConformanceVerdictInput |
— | — |
PreflightReportState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PreflightReportID! |
— | — |
componentId |
ComponentID! |
— | — |
artworkFileId |
ComponentArtworkFileID |
— | — |
status |
String! |
— | — |
profileUsed |
String! |
— | — |
pageCount |
Int! |
— | — |
errorCount |
Int! |
— | — |
pdfVersion |
String! |
— | — |
engineVersion |
String! |
— | — |
report |
PreflightReport! |
— | — |
outputFileId |
FileID |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
component |
ComponentState |
— | — |
artworkFile |
ComponentArtworkFileState |
— | — |
outputFile |
FileState |
— | — |
PreflightRule
FONT_NOT_EMBEDDED, TRIM_BOX_MISSING, BLEED_BOX_MISSING, PAGE_BOX_HIERARCHY, TAC_OVER_LIMIT, RGB_IN_CMYK_WORKFLOW, IMAGE_RESOLUTION_LOW, HAIRLINE_RULE, STRUCTURAL_ERROR, TRANSPARENCY_PRESENT, OVERPRINT_USED, EXCESS_SPOT_COLORS, OBJECT_OUTSIDE_TRIM, OBJECT_NEAR_TRIM, PDF_X_VERSION_KEY_MISSING, PDF_X_OUTPUT_INTENT_INVALID, PDF_X_FONT_NOT_EMBEDDED, PDF_X_ENCRYPTION_PROHIBITED, PDF_X_DEVICE_INDEPENDENT_COLOR, PDF_X_TRANSPARENCY_PROHIBITED, PDF_X_TRIM_BOX_MISSING, PDF_X_VERSION_CEILING_EXCEEDED, PDF_X_TRAPPED_KEY_INVALID, PDF_X_PROHIBITED_ACTION, PDF_X_ANNOTATION_IN_TRIM, PDF_X_CLAIMED_CONFORMANCE_FAILED, PDF_X_UNKNOWN_DECLARED_STANDARD, PDF_X_LAYERS_PROHIBITED, PDF_X_FILE_ID_MISSING, PDF_X_EMBEDDED_POSTSCRIPT_PROHIBITED, PDF_X_OPI_PROHIBITED, PDF_X_LZW_PROHIBITED, PDF_X_BOX_NESTING, PDF_X_TRANSFER_FUNCTION_PROHIBITED, PROC_STEP_CUSTOM, PROC_STEP_TYPE_ON_TYPELESS_GROUP, PROC_STEP_CUSTOM_MISSING_CLASS_NAME, PROC_STEP_UNDEFINED_TYPE, PROC_STEP_UNDEFINED_TYPE_WITH_CLASS_NAME, PROC_STEP_COLORANT_SHARED_WITH_PRINTING, PROC_STEP_PROCESS_COLORANT, PROC_STEP_RESERVED_COLORANT, PROC_STEP_MULTIPLE_COLORANTS, PROC_STEP_TRANSPARENCY, PROC_STEP_IMAGE, PROC_STEP_NON_STROKE_IN_STROKE_ONLY, PROC_STEP_ZERO_TINT, PROC_STEP_NOT_OFF_BLEED, PROC_STEP_PRINTING_ABOVE_STEP, PROC_STEP_KNOCKOUT, UNKNOWN
PreflightSeverity
INFO, WARNING, ERROR
PreflightStatus
PASS, WARNING, FAIL
PrepressOperationKind
PREFLIGHT, RIP, CTP, PROOF, COLOR_CONVERSION, IMPOSITION, COLOR_MANAGEMENT, TRAPPING, OTHER
PrepressOperationState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PrepressOperationID! |
— | — |
componentId |
ComponentID! |
— | — |
kind |
PrepressOperationKind! |
— | — |
status |
PrepressOperationStatus! |
— | — |
notes |
String |
— | — |
assignedUserId |
UserID |
— | — |
outputFileId |
FileID |
— | — |
startedAt |
String |
— | — |
completedAt |
String |
— | — |
sortOrder |
Int! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
component |
ComponentState |
— | — |
assignedUser |
UserState |
— | — |
outputFile |
FileState |
— | — |
PrepressOperationStatus
PENDING, IN_PROGRESS, COMPLETED, FAILED, SKIPPED
PreviewImpositionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
finishedWidth |
LengthInput! |
— | — |
finishedHeight |
LengthInput! |
— | — |
totalPages |
Int! |
— | — |
bleed |
LengthInput |
— | — |
quantity |
Int |
— | — |
mode |
ImposingMode |
— | — |
bindingSide |
BindingSide |
— | — |
bindingType |
BindingType |
— | — |
substrateIds |
[String!]! |
— | — |
permittedFolds |
[String!] |
— | — |
maxPagesUp |
Int |
— | — |
scheme |
ImpositionScheme |
— | — |
gutterH |
LengthInput |
— | — |
gutterV |
LengthInput |
— | — |
gripEdge |
LengthInput |
— | — |
tailEdge |
LengthInput |
— | — |
sideMargin |
LengthInput |
— | — |
gangingRows |
Int |
— | — |
gangingCols |
Int |
— | — |
webPressProfile |
WebPressProfileInput |
— | — |
wasteWeight |
Float |
— | — |
utilisationWeight |
Float |
— | — |
sigCountWeight |
Float |
— | — |
foldUniformityWeight |
Float |
— | — |
PreviewImpositionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
plans |
[ImposingPlan!]! |
— | — |
gangingPlans |
[GangingPlan!]! |
— | — |
webPlans |
[WebImposingPlan!]! |
— | — |
recommendedIndex |
Int! |
— | — |
errors |
[FieldError!]! |
— | — |
ProductionFlagsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
customHalftone |
Boolean! |
— | — |
customTransfer |
Boolean! |
— | — |
customBlackGeneration |
Boolean! |
— | — |
customUnderColorRemoval |
Boolean! |
— | — |
ProductionIntent
| Field | Type | Default | Arguments |
|---|---|---|---|
operations |
[ProductionOperation!]! |
— | — |
summary |
ProductionSummary! |
— | — |
ProductionKind
SADDLE_STITCHED, PERFECT_BOUND, WIRE_BOUND, CASE_BOUND, FLATWORK, FOLDED, OTHER
ProductionOperation
| Field | Type | Default | Arguments |
|---|---|---|---|
ocgName |
String! |
— | — |
group |
String! |
— | — |
stepType |
String |
— | — |
operation |
ProductionOperationKind! |
— | — |
jdfProcess |
String! |
— | — |
colorant |
String |
— | — |
pages |
[Int!]! |
— | — |
extentMM |
[Float!]! |
— | — |
totalLengthMM |
Float! |
— | — |
segmentCount |
Int! |
— | — |
subpathCount |
Int! |
— | — |
closedContours |
Int! |
— | — |
openPaths |
Int! |
— | — |
coverage |
ProductionCoverage |
— | — |
ProductionOperationKind
CUT, REVERSE_CUT, PARTIAL_CUT, CREASE, FOLD, PERFORATE, PUNCH, DRILL, GLUE, BLEED, VARNISH, WHITE_UNDERPRINT, DIMENSION, POSITION, LEGEND, CUSTOM, UNKNOWN
ProductionSummary
| Field | Type | Default | Arguments |
|---|---|---|---|
finishedWidthMM |
Float |
— | — |
finishedHeightMM |
Float |
— | — |
numberUp |
Int |
— | — |
pageCount |
Int! |
— | — |
totalCutLengthMM |
Float! |
— | — |
totalCreaseLengthMM |
Float! |
— | — |
totalPerfLengthMM |
Float! |
— | — |
foldCount |
Int! |
— | — |
varnishAreaMM2 |
Float |
— | — |
whiteAreaMM2 |
Float |
— | — |
spotCount |
Int! |
— | — |
ProgressErrorSeverity
INFO, WARNING, ERROR, FATAL
ProgressPhase
SETUP, RUNNING, CLEANUP, IDLE, MAINTENANCE, STOPPED
ProgressPointConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[ProgressPointEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
ProgressPointEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
ProgressPointState! |
— | — |
cursor |
String! |
— | — |
ProgressPointFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
IDFilter |
— | — |
operationId |
IDFilter |
— | — |
operationItemId |
IDFilter |
— | — |
componentId |
IDFilter |
— | — |
workCenterId |
IDFilter |
— | — |
userId |
IDFilter |
— | — |
phase |
StringFilter |
— | — |
source |
StringFilter |
— | — |
from |
ISO8601 |
— | — |
to |
ISO8601 |
— | — |
ProgressPointState
| Field | Type | Default | Arguments |
|---|---|---|---|
timestamp |
ISO8601! |
— | — |
jobId |
JobID |
— | — |
operationId |
OperationID |
— | — |
operationItemId |
OperationItemID |
— | — |
componentId |
ComponentID |
— | — |
workCenterId |
WorkCenterID |
— | — |
userId |
UserID |
— | — |
phase |
ProgressPhase |
— | — |
phaseDurationSeconds |
Float |
— | — |
goodCount |
Float |
— | — |
wasteCount |
Float |
— | — |
totalPlanned |
Float |
— | — |
countUnit |
MetricUnit |
— | — |
customCountUnit |
String |
— | — |
percentComplete |
Float |
— | — |
speed |
Float |
— | — |
speedUnit |
MetricUnit |
— | — |
customSpeedUnit |
String |
— | — |
status |
String |
— | — |
errorCode |
String |
— | — |
errorMessage |
String |
— | — |
errorSeverity |
ProgressErrorSeverity |
— | — |
source |
ProgressSource |
— | — |
tags |
[Dictionary!]! |
— | — |
ProgressSource
JMF, MQTT, MANUAL, API, SYSTEM
PublishTemplateVersionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
templateId |
TemplateID! |
— | — |
description |
String |
— | — |
PublishTemplateVersionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
version |
TemplateVersionState |
— | — |
errors |
[FieldError!]! |
— | — |
RecordProgressPointInput
| Field | Type | Default | Arguments |
|---|---|---|---|
externalRef |
ExternalRefInput |
— | — |
operationId |
OperationID |
— | — |
operationItemId |
OperationItemID |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
workCenterId |
WorkCenterID |
— | — |
userId |
UserID |
— | — |
timestamp |
ISO8601 |
— | — |
phase |
ProgressPhase |
— | — |
phaseDurationSeconds |
Float |
— | — |
goodCount |
Float |
— | — |
wasteCount |
Float |
— | — |
totalPlanned |
Float |
— | — |
countUnit |
MetricUnit |
— | — |
customCountUnit |
String |
— | — |
percentComplete |
Float |
— | — |
speed |
Float |
— | — |
speedUnit |
MetricUnit |
— | — |
customSpeedUnit |
String |
— | — |
status |
String |
— | — |
errorCode |
String |
— | — |
errorMessage |
String |
— | — |
errorSeverity |
ProgressErrorSeverity |
— | — |
source |
ProgressSource |
— | — |
tags |
[DictionaryInput!] |
— | — |
RecordProgressPointsInput
| Field | Type | Default | Arguments |
|---|---|---|---|
points |
[RecordProgressPointInput!]! |
— | — |
RecordProgressPointsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
recorded |
Int! |
— | — |
errors |
[FieldError!]! |
— | — |
RenderArtworkPreviewInput
| Field | Type | Default | Arguments |
|---|---|---|---|
artworkFileId |
ComponentArtworkFileID! |
— | — |
page |
Int |
— | — |
maxEdgePixels |
Int |
— | — |
quality |
Int |
— | — |
RenderArtworkPreviewPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
imageBase64 |
String |
— | — |
contentType |
String |
— | — |
errors |
[FieldError!]! |
— | — |
RenderImpositionSVGInput
| Field | Type | Default | Arguments |
|---|---|---|---|
impositionSpecId |
ImpositionSpecID |
— | — |
layoutJSON |
String |
— | — |
side |
SurfaceSide |
— | — |
showPageNumbers |
Boolean |
— | — |
showFoldLines |
Boolean |
— | — |
showTrimMarks |
Boolean |
— | — |
showMargins |
Boolean |
— | — |
showBlankCells |
Boolean |
— | — |
maxWidth |
Float |
— | — |
RenderImpositionSVGPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
svg |
String |
— | — |
errors |
[String!]! |
— | — |
RenderPlateSeparationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
artworkFileId |
ComponentArtworkFileID! |
— | — |
page |
Int |
— | — |
separation |
String! |
— | — |
dpi |
Int |
— | — |
polarity |
SeparationPolarity |
— | — |
RenderPreviewInput
| Field | Type | Default | Arguments |
|---|---|---|---|
pdfBytes |
BinaryBase64! |
— | — |
page |
Int |
— | — |
maxEdgePixels |
Int |
— | — |
quality |
Int |
— | — |
RenderSeparationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
pdfBytes |
BinaryBase64! |
— | — |
page |
Int |
— | — |
separation |
String! |
— | — |
dpi |
Int |
— | — |
polarity |
SeparationPolarity |
— | — |
RenderTemplateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
handle |
String! |
— | — |
context |
String! |
— | — |
RenderTemplatePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
output |
String |
— | — |
errors |
[String!]! |
— | — |
RequestFileUploadInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderId |
OrderID |
— | — |
estimateId |
EstimateID |
— | — |
invoiceId |
InvoiceID |
— | — |
purchaseOrderId |
PurchaseOrderID |
— | — |
name |
String! |
— | — |
originalFilename |
String! |
— | — |
mimeType |
String! |
— | — |
sizeBytes |
Int! |
— | — |
category |
FileCategory! |
— | — |
checksum |
String |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
parentFileId |
FileID |
— | — |
folderId |
FolderID |
— | — |
RequestFileUploadsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
grants |
[FileUploadGrant!]! |
— | — |
errors |
[FieldError!]! |
— | — |
ResolveNodeOutputSchemaInput
| Field | Type | Default | Arguments |
|---|---|---|---|
nodeType |
String! |
— | — |
config |
JSON! |
— | — |
ResourceType
MACHINE, HUMAN, TOOL, LOCATION
RestoreTemplateVersionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
templateId |
TemplateID! |
— | — |
versionId |
TemplateVersionID! |
— | — |
RunPreflightInput
| Field | Type | Default | Arguments |
|---|---|---|---|
artworkFileId |
ComponentArtworkFileID! |
— | — |
profile |
PreflightProfile |
— | — |
RunPreflightPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
preflightReport |
PreflightReportState |
— | — |
errors |
[FieldError!]! |
— | — |
RunProvenance
| Field | Type | Default | Arguments |
|---|---|---|---|
profileName |
String! |
— | — |
engineVersion |
String! |
— | — |
timestamp |
String |
— | — |
RunProvenanceInput
| Field | Type | Default | Arguments |
|---|---|---|---|
profileName |
String! |
— | — |
engineVersion |
String! |
— | — |
timestamp |
String |
— | — |
S3Backend
| Field | Type | Default | Arguments |
|---|---|---|---|
endpoint |
String! |
— | — |
region |
String! |
— | — |
bucket |
String! |
— | — |
pathStyle |
Boolean! |
— | — |
hasCredentials |
Boolean! |
— | — |
credentialsUpdatedAt |
String |
— | — |
S3BackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
endpoint |
String |
— | — |
region |
String |
— | — |
bucket |
String |
— | — |
pathStyle |
Boolean |
— | — |
accessKeyId |
String |
— | — |
secretAccessKey |
String |
— | — |
ScheduledTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
cronExpression |
String! |
— | — |
timezone |
String |
— | — |
overlapPolicy |
OverlapPolicy! |
— | — |
SeparationPolarity
POSITIVE, NEGATIVE
SetActiveVersionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
workflow |
WorkflowState |
— | — |
errors |
[FieldError!]! |
— | — |
SettingsChange
| Field | Type | Default | Arguments |
|---|---|---|---|
at |
ISO8601! |
— | — |
user |
UserID! |
— | — |
userName |
String |
— | — |
SheetLayout
| Field | Type | Default | Arguments |
|---|---|---|---|
unit |
LayoutUnit! |
— | — |
sheetWidth |
Length! |
— | — |
sheetHeight |
Length! |
— | — |
finishedWidth |
Length! |
— | — |
finishedHeight |
Length! |
— | — |
bleed |
Length! |
— | — |
gripEdge |
Length! |
— | — |
tailEdge |
Length! |
— | — |
sideMargin |
Length! |
— | — |
cols |
Int! |
— | — |
rows |
Int! |
— | — |
gutterH |
Length! |
— | — |
gutterV |
Length! |
— | — |
media |
SheetMedia |
— | — |
cells |
[PlacedCell!]! |
— | — |
foldLines |
[FoldLine!]! |
— | — |
trimMarks |
[TrimMark!]! |
— | — |
layers |
[LayoutLayer!]! |
— | — |
surfaces |
[SheetSurface!]! |
— | — |
SheetLineAxis
HORIZONTAL, VERTICAL
SheetMedia
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
weight |
PaperWeight |
— | — |
thickness |
Length |
— | — |
coating |
String |
— | — |
grainDirection |
String |
— | — |
color |
String |
— | — |
stockType |
String |
— | — |
texture |
String |
— | — |
SheetSurface
| Field | Type | Default | Arguments |
|---|---|---|---|
side |
SurfaceSide! |
— | — |
cells |
[PlacedCell!]! |
— | — |
SignatureResult
| Field | Type | Default | Arguments |
|---|---|---|---|
index |
Int! |
— | — |
foldPatternId |
String! |
— | — |
pagesUp |
Int! |
— | — |
sheetsPerForm |
Int! |
— | — |
pageRangeStart |
Int! |
— | — |
pageRangeEnd |
Int! |
— | — |
pages |
[Int!]! |
— | — |
scheme |
ImpositionScheme! |
— | — |
orientation |
ImpositionOrientation! |
— | — |
layout |
SignatureLayout! |
— | — |
sheetLayout |
SheetLayout |
— | — |
SortDirection
ASC, DESC
SourceDiagnostic
| Field | Type | Default | Arguments |
|---|---|---|---|
document |
String! |
— | — |
startLine |
Int! |
— | — |
startColumn |
Int! |
— | — |
endLine |
Int! |
— | — |
endColumn |
Int! |
— | — |
startOffset |
Int! |
— | — |
endOffset |
Int! |
— | — |
elementID |
String |
— | — |
attribute |
String |
— | — |
inputPath |
String |
— | — |
StepStatus
PENDING, RUNNING, WAITING, COMPLETED, FAILED, SKIPPED, WAITING_RETRY
StorageBackendAuthorizationOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
authorizationUrl |
String! |
— | — |
pendingBackendId |
StorageBackendID! |
— | — |
StorageBackendConfig
StorageBackendConfig
StorageBackendConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
s3 |
S3BackendInput |
— | — |
hostPath |
HostPathBackendInput |
— | — |
ftp |
FTPBackendInput |
— | — |
StorageBackendConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[StorageBackendEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
StorageBackendConnectionStatus
CONNECTED, NEEDS_REAUTHORIZATION
StorageBackendEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
StorageBackendOutput! |
— | — |
cursor |
String! |
— | — |
StorageBackendFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
StorageBackendOAuthProvider
GOOGLE_DRIVE, DROPBOX
StorageBackendOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
StorageBackendID! |
— | — |
tenantId |
TenantID! |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
config |
StorageBackendConfig! |
— | — |
status |
StorageBackendConnectionStatus! |
— | — |
reauthorizationReason |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
StorageBackendProbeResult
| Field | Type | Default | Arguments |
|---|---|---|---|
ok |
Boolean! |
— | — |
error |
String |
— | — |
StorageBackendSortField
NAME, CREATED_AT, UPDATED_AT
StorageBackendSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
StorageBackendSortField! |
— | — |
direction |
SortDirection! |
— | — |
StorageCapabilitiesOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
cloudFileUploadsAvailable |
Boolean |
— | — |
cloudFileStorageAccountConfigured |
Boolean |
— | — |
cloudFileStorageConfigurationValid |
Boolean |
— | — |
cloudFileUploadsDiagnostic |
String! |
— | — |
hostPathStorageEnabled |
Boolean! |
— | — |
StringFilter
| Field | Type | Default | Arguments |
|---|---|---|---|
eq |
String |
— | — |
neq |
String |
— | — |
contains |
String |
— | — |
startsWith |
String |
— | — |
endsWith |
String |
— | — |
in |
[String!] |
— | — |
notIn |
[String!] |
— | — |
SubstrateConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[SubstrateEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
SubstrateEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
SubstrateState! |
— | — |
cursor |
String! |
— | — |
SubstrateFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
externalId |
StringFilter |
— | — |
isActive |
BoolFilter |
— | — |
kind |
StringFilter |
— | — |
coating |
StringFilter |
— | — |
SubstrateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
name |
String! |
— | — |
width |
Length! |
— | — |
height |
Length! |
— | — |
thickness |
Length |
— | — |
weight |
PaperWeight |
— | — |
coating |
String |
— | — |
grainDirection |
String |
— | — |
color |
String |
— | — |
stockType |
String |
— | — |
texture |
String |
— | — |
SubstrateSortField
NAME, WEIGHT, CREATED_AT
SubstrateSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
SubstrateSortField! |
— | — |
direction |
SortDirection! |
— | — |
SubstrateState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
SubstrateID! |
— | — |
externalId |
String |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
externalCode |
String |
— | — |
supplierCode |
String |
— | — |
supplierId |
SupplierID |
— | — |
manufacturer |
String |
— | — |
brand |
String |
— | — |
kind |
MediaKind |
— | — |
mediaType |
MediaType |
— | — |
isoPaperSubstrate |
ISOPaperSubstrate |
— | — |
width |
Length |
— | — |
height |
Length |
— | — |
weight |
PaperWeight |
— | — |
thickness |
Length |
— | — |
coatings |
[MediaCoating!] |
— | — |
grainDirection |
MediaGrainDirection |
— | — |
imageableSide |
MediaImageableSide |
— | — |
opacity |
MediaOpacity |
— | — |
printingTechnology |
MediaPrintingTechnology |
— | — |
stockType |
MediaStockType |
— | — |
texture |
MediaTexture |
— | — |
color |
MediaColor |
— | — |
preAppliedCoatings |
[MediaCoating!] |
— | — |
shrinkIndex |
[Float!] |
— | — |
brightness |
Float |
— | — |
cieWhiteness |
Float |
— | — |
grade |
Int |
— | — |
fluteType |
MediaFluteType |
— | — |
recycledPercentage |
Float |
— | — |
buyerSupplied |
Boolean! |
— | — |
moisture |
Float |
— | — |
supplierLeadTimeDays |
Int |
— | — |
isActive |
Boolean! |
— | — |
reorderThreshold |
Float |
— | — |
reorderUnit |
MeasurementUnit |
— | — |
unitCost |
Float |
— | — |
costCurrency |
CurrencyISO |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
SubstrateTemplateLineState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
SubstrateTemplateLineID! |
— | — |
productTemplateId |
ProductTemplateID! |
— | — |
componentLocalId |
String |
— | — |
substrateId |
SubstrateID! |
— | — |
quantityPer100 |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
wasteFactor |
Float! |
— | — |
notes |
String |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
SurfaceSide
FRONT, BACK
TemplateConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[TemplateEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
TemplateEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
TemplateState! |
— | — |
cursor |
String! |
— | — |
TemplateFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
handle |
StringFilter |
— | — |
kind |
TemplateKind |
— | — |
createdAt |
DateFilter |
— | — |
updatedAt |
DateFilter |
— | — |
TemplateKind
STENCIL, XMLPDF, XML
TemplateSortField
HANDLE, CREATED_AT, UPDATED_AT
TemplateSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
TemplateSortField! |
— | — |
direction |
SortDirection! |
— | — |
TemplateState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
TemplateID! |
— | — |
handle |
String! |
— | — |
kind |
TemplateKind! |
— | — |
content |
String! |
— | — |
description |
String |
— | — |
currentVersionId |
TemplateVersionID |
— | — |
currentVersion |
Int |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
TemplateVersionConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[TemplateVersionEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
TemplateVersionEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
TemplateVersionState! |
— | — |
cursor |
String! |
— | — |
TemplateVersionState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
TemplateVersionID! |
— | — |
templateId |
TemplateID! |
— | — |
version |
Int! |
— | — |
kind |
TemplateKind! |
— | — |
content |
String! |
— | — |
description |
String |
— | — |
createdAt |
ISO8601! |
— | — |
TriggerConfig
TriggerConfig
TriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
scheduled |
ScheduledTriggerConfigInput |
— | — |
event |
EventTriggerConfigInput |
— | — |
deviceMqtt |
DeviceMQTTTriggerConfigInput |
— | — |
webhook |
WebhookTriggerConfigInput |
— | — |
edgeAppEvent |
EdgeAppEventTriggerConfigInput |
— | — |
folderWatch |
FolderWatchTriggerConfigInput |
— | — |
TriggerType
MANUAL, SCHEDULED, EVENT, DEVICE_MQTT, WEBHOOK, SCRIPT, EDGE_APP_EVENT, FOLDER_WATCH
TrimMark
| Field | Type | Default | Arguments |
|---|---|---|---|
axis |
SheetLineAxis! |
— | — |
position |
Length! |
— | — |
UpdateFileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderId |
OrderID |
— | — |
estimateId |
EstimateID |
— | — |
invoiceId |
InvoiceID |
— | — |
purchaseOrderId |
PurchaseOrderID |
— | — |
name |
String |
— | — |
originalFilename |
String |
— | — |
mimeType |
String |
— | — |
sizeBytes |
Int |
— | — |
externalStorageKey |
String |
— | — |
checksum |
String |
— | — |
category |
FileCategory |
— | — |
status |
FileStatus |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
parentFileId |
FileID |
— | — |
versionNumber |
Int |
— | — |
processingMetadata |
JSONMap |
— | — |
uploadedByUserId |
UserID |
— | — |
UpdateFolderInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
description |
String |
— | — |
kind |
FolderBindingKind |
— | — |
storageBackendId |
StorageBackendID |
— | — |
controllerId |
ControllerID |
— | — |
rootPath |
String |
— | — |
isDefault |
Boolean |
— | — |
UpdateImposingSettingsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
imposing |
ImposingSettings |
— | — |
errors |
[FieldError!]! |
— | — |
UpdatePaperWeightSettingsPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
paperWeight |
PaperWeightSettings |
— | — |
errors |
[FieldError!]! |
— | — |
UpdateStorageBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
description |
String |
— | — |
config |
StorageBackendConfigInput |
— | — |
UpdateSubstrateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
externalId |
String |
— | — |
name |
String |
— | — |
code |
String |
— | — |
externalCode |
String |
— | — |
supplierCode |
String |
— | — |
supplierId |
SupplierID |
— | — |
manufacturer |
String |
— | — |
brand |
String |
— | — |
kind |
MediaKind |
— | — |
mediaType |
MediaType |
— | — |
isoPaperSubstrate |
ISOPaperSubstrate |
— | — |
width |
LengthInput |
— | — |
height |
LengthInput |
— | — |
weight |
PaperWeightInput |
— | — |
thickness |
LengthInput |
— | — |
coatings |
[MediaCoating!] |
— | — |
grainDirection |
MediaGrainDirection |
— | — |
imageableSide |
MediaImageableSide |
— | — |
opacity |
MediaOpacity |
— | — |
printingTechnology |
MediaPrintingTechnology |
— | — |
stockType |
MediaStockType |
— | — |
texture |
MediaTexture |
— | — |
color |
MediaColor |
— | — |
preAppliedCoatings |
[MediaCoating!] |
— | — |
shrinkIndex |
[Float!] |
— | — |
brightness |
Float |
— | — |
cieWhiteness |
Float |
— | — |
grade |
Int |
— | — |
fluteType |
MediaFluteType |
— | — |
recycledPercentage |
Float |
— | — |
buyerSupplied |
Boolean |
— | — |
moisture |
Float |
— | — |
supplierLeadTimeDays |
Int |
— | — |
isActive |
Boolean |
— | — |
reorderThreshold |
Float |
— | — |
reorderUnit |
MeasurementUnit |
— | — |
unitCost |
Float |
— | — |
costCurrency |
CurrencyISO |
— | — |
notes |
String |
— | — |
UpdateSubstrateTemplateLineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
productTemplateId |
ProductTemplateID |
— | — |
componentLocalId |
String |
— | — |
substrateId |
SubstrateID |
— | — |
quantityPer100 |
Float |
— | — |
unit |
MeasurementUnit |
— | — |
wasteFactor |
Float |
— | — |
notes |
String |
— | — |
UpdateTemplateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
handle |
String |
— | — |
kind |
TemplateKind |
— | — |
content |
String |
— | — |
description |
String |
— | — |
UpdateWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
description |
String |
— | — |
isActive |
Boolean |
— | — |
botUserId |
UserID |
— | — |
defaultNodeTimeoutSeconds |
Int |
— | — |
UpdateWorkflowTriggerInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String |
— | — |
config |
TriggerConfigInput |
— | — |
isEnabled |
Boolean |
— | — |
concurrencyPolicy |
ConcurrencyPolicy |
— | — |
maxConcurrentExecutions |
Int |
— | — |
UpsertComponentArtworkFileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ComponentArtworkFileID |
— | — |
componentId |
ComponentID! |
— | — |
fileId |
FileID |
— | — |
externalUri |
String |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
description |
String |
— | — |
pageCount |
Int |
— | — |
pageRange |
String |
— | — |
sortOrder |
Int |
— | — |
UpsertComponentArtworkFilePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
artworkFile |
ComponentArtworkFileState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertFileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
FileID |
— | — |
jobId |
JobID |
— | — |
componentId |
ComponentID |
— | — |
orderId |
OrderID |
— | — |
estimateId |
EstimateID |
— | — |
invoiceId |
InvoiceID |
— | — |
purchaseOrderId |
PurchaseOrderID |
— | — |
name |
String! |
— | — |
originalFilename |
String! |
— | — |
mimeType |
String! |
— | — |
sizeBytes |
Int! |
— | — |
externalStorageKey |
String |
— | — |
checksum |
String |
— | — |
category |
FileCategory! |
— | — |
status |
FileStatus |
— | — |
usageRole |
ComponentFileUsageRole |
— | — |
parentFileId |
FileID |
— | — |
versionNumber |
Int |
— | — |
processingMetadata |
JSONMap |
— | — |
uploadedByUserId |
UserID |
— | — |
UpsertFilePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
file |
FileState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertImpositionSpecInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
ImpositionSpecID |
— | — |
componentId |
ComponentID! |
— | — |
name |
String |
— | — |
description |
String |
— | — |
isPrimary |
Boolean |
— | — |
pagesUp |
Int |
— | — |
sheetsPerForm |
Int |
— | — |
totalForms |
Int |
— | — |
totalPages |
Int |
— | — |
scheme |
ImpositionScheme |
— | — |
orientation |
ImpositionOrientation |
— | — |
bindingType |
BindingType |
— | — |
gutterH |
LengthInput |
— | — |
gutterV |
LengthInput |
— | — |
sortOrder |
Int |
— | — |
UpsertImpositionSpecPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
impositionSpec |
ImpositionSpecState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertPreflightReportInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PreflightReportID |
— | — |
componentId |
ComponentID! |
— | — |
artworkFileId |
ComponentArtworkFileID |
— | — |
report |
PreflightReportInput! |
— | — |
outputFileId |
String |
— | — |
UpsertPreflightReportPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
preflightReport |
PreflightReportState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertPrepressOperationInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
PrepressOperationID |
— | — |
componentId |
ComponentID! |
— | — |
kind |
PrepressOperationKind! |
— | — |
status |
PrepressOperationStatus |
— | — |
notes |
String |
— | — |
assignedUserId |
UserID |
— | — |
outputFileId |
String |
— | — |
startedAt |
String |
— | — |
completedAt |
String |
— | — |
sortOrder |
Int |
— | — |
UpsertPrepressOperationPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
prepressOperation |
PrepressOperationState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertStorageBackendInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
StorageBackendID |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
config |
StorageBackendConfigInput! |
— | — |
UpsertStorageBackendPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
storageBackend |
StorageBackendOutput |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertSubstrateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
SubstrateID |
— | — |
externalId |
String |
— | — |
name |
String! |
— | — |
code |
String |
— | — |
externalCode |
String |
— | — |
supplierCode |
String |
— | — |
supplierId |
SupplierID |
— | — |
manufacturer |
String |
— | — |
brand |
String |
— | — |
kind |
MediaKind |
— | — |
mediaType |
MediaType |
— | — |
isoPaperSubstrate |
ISOPaperSubstrate |
— | — |
width |
LengthInput |
— | — |
height |
LengthInput |
— | — |
weight |
PaperWeightInput |
— | — |
thickness |
LengthInput |
— | — |
coatings |
[MediaCoating!] |
— | — |
grainDirection |
MediaGrainDirection |
— | — |
imageableSide |
MediaImageableSide |
— | — |
opacity |
MediaOpacity |
— | — |
printingTechnology |
MediaPrintingTechnology |
— | — |
stockType |
MediaStockType |
— | — |
texture |
MediaTexture |
— | — |
color |
MediaColor |
— | — |
preAppliedCoatings |
[MediaCoating!] |
— | — |
shrinkIndex |
[Float!] |
— | — |
brightness |
Float |
— | — |
cieWhiteness |
Float |
— | — |
grade |
Int |
— | — |
fluteType |
MediaFluteType |
— | — |
recycledPercentage |
Float |
— | — |
buyerSupplied |
Boolean |
— | — |
moisture |
Float |
— | — |
supplierLeadTimeDays |
Int |
— | — |
isActive |
Boolean |
— | — |
reorderThreshold |
Float |
— | — |
reorderUnit |
MeasurementUnit |
— | — |
unitCost |
Float |
— | — |
costCurrency |
CurrencyISO |
— | — |
notes |
String |
— | — |
UpsertSubstratePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
substrate |
SubstrateState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertSubstrateTemplateLineInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
SubstrateTemplateLineID |
— | — |
productTemplateId |
ProductTemplateID! |
— | — |
componentLocalId |
String |
— | — |
substrateId |
SubstrateID! |
— | — |
quantityPer100 |
Float! |
— | — |
unit |
MeasurementUnit! |
— | — |
wasteFactor |
Float |
— | — |
notes |
String |
— | — |
UpsertSubstrateTemplateLinePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
substrateTemplateLine |
SubstrateTemplateLineState |
— | — |
errors |
[FieldError!]! |
— | — |
UpsertTemplateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
TemplateID |
— | — |
handle |
String! |
— | — |
kind |
TemplateKind |
— | — |
content |
String! |
— | — |
description |
String |
— | — |
UpsertTemplatePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
template |
TemplateState |
— | — |
errors |
[FieldError!]! |
— | — |
UserKind
HUMAN, BOT
UserState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
UserID! |
— | — |
externalId |
String |
— | — |
email |
String! |
— | — |
name |
String |
— | — |
kind |
UserKind! |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
ValidateJinjaInput
| Field | Type | Default | Arguments |
|---|---|---|---|
source |
String! |
— | — |
format |
ExpressionFormat! |
— | — |
ValidateJinjaResult
| Field | Type | Default | Arguments |
|---|---|---|---|
success |
Boolean! |
— | — |
diagnostics |
[JinjaDiagnostic!]! |
— | — |
ValidateTemplateInput
| Field | Type | Default | Arguments |
|---|---|---|---|
kind |
TemplateKind |
— | — |
content |
String! |
— | — |
ValidateTemplatePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
valid |
Boolean! |
— | — |
errors |
[String!]! |
— | — |
ValidateWorkflowInput
| Field | Type | Default | Arguments |
|---|---|---|---|
content |
String! |
— | — |
format |
WorkflowSerializationFormat! |
— | — |
ValidateWorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
warnings |
[FieldError!]! |
— | — |
isValid |
Boolean! |
— | — |
errors |
[FieldError!]! |
— | — |
WebGrainOrientation
LONG_GRAIN, SHORT_GRAIN
WebhookTriggerConfigInput
| Field | Type | Default | Arguments |
|---|---|---|---|
path |
String! |
— | — |
method |
String! |
— | — |
authRequired |
Boolean! |
— | — |
WebImposingPlan
| Field | Type | Default | Arguments |
|---|---|---|---|
pressProfile |
WebPressProfile! |
— | — |
pagesAcross |
Int! |
— | — |
pagesAround |
Int! |
— | — |
pagesPerRibbonSide |
Int! |
— | — |
pagesPerRibbon |
Int! |
— | — |
numberOfRibbons |
Int! |
— | — |
totalForms |
Int! |
— | — |
utilisation |
Float! |
— | — |
wastePages |
Int! |
— | — |
totalCutoffs |
Int |
— | — |
layout |
SheetLayout! |
— | — |
foldPatternId |
String! |
— | — |
scheme |
ImpositionScheme! |
— | — |
WebPressProfile
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
webWidth |
Length! |
— | — |
cutoff |
Length! |
— | — |
maxRibbons |
Int! |
— | — |
perfecting |
Boolean! |
— | — |
grainOrientation |
WebGrainOrientation! |
— | — |
WebPressProfileInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
webWidth |
LengthInput! |
— | — |
cutoff |
LengthInput! |
— | — |
maxRibbons |
Int |
— | — |
perfecting |
Boolean |
— | — |
grainOrientation |
WebGrainOrientation |
— | — |
WorkCenterLifecycle
CONCEPT, ACTIVE, ARCHIVED
WorkCenterState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkCenterID! |
— | — |
externalId |
String |
— | — |
productionCellId |
ProductionCellID |
— | — |
costCenterId |
CostCenterID |
— | — |
name |
String! |
— | — |
resourceType |
ResourceType! |
— | — |
linkedUserId |
UserID |
— | — |
efficiencyFactor |
Float! |
— | — |
isActive |
Boolean! |
— | — |
lifecycle |
WorkCenterLifecycle! |
— | — |
isMonitored |
Boolean! |
— | — |
jmfDeviceId |
String |
— | — |
defaultSetupMinutes |
Int! |
— | — |
defaultProcessingRate |
Float |
— | — |
defaultCleanupMinutes |
Int! |
— | — |
twin |
WorkCenterTwin! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
WorkflowConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WorkflowEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WorkflowDefinition
| Field | Type | Default | Arguments |
|---|---|---|---|
inputSchema |
String |
— | — |
nodes |
[WorkflowNodeDefinition!]! |
— | — |
edges |
[WorkflowEdgeDefinition!]! |
— | — |
variables |
[WorkflowVariableDefinition!]! |
— | — |
WorkflowDefinitionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
inputSchema |
String |
— | — |
nodes |
[WorkflowNodeDefinitionInput!]! |
— | — |
edges |
[WorkflowEdgeDefinitionInput!]! |
— | — |
variables |
[WorkflowVariableDefinitionInput!] |
— | — |
WorkflowEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WorkflowState! |
— | — |
cursor |
String! |
— | — |
WorkflowEdgeDefinition
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
fromNodeId |
String! |
— | — |
toNodeId |
String! |
— | — |
condition |
String |
— | — |
WorkflowEdgeDefinitionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
String! |
— | — |
fromNodeId |
String! |
— | — |
toNodeId |
String! |
— | — |
condition |
String |
— | — |
WorkflowExecutionConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WorkflowExecutionEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WorkflowExecutionEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WorkflowExecutionState! |
— | — |
cursor |
String! |
— | — |
WorkflowExecutionErrorOutput
| Field | Type | Default | Arguments |
|---|---|---|---|
code |
String! |
— | — |
message |
String! |
— | — |
nodeId |
String |
— | — |
details |
String |
— | — |
WorkflowExecutionFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
IDFilter |
— | — |
status |
StringFilter |
— | — |
triggerType |
StringFilter |
— | — |
startedAt |
DateFilter |
— | — |
completedAt |
DateFilter |
— | — |
WorkflowExecutionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
execution |
WorkflowExecutionState |
— | — |
errors |
[FieldError!]! |
— | — |
runtimeCleanup |
String |
— | — |
WorkflowExecutionRuntimeManagementState
| Field | Type | Default | Arguments |
|---|---|---|---|
executionId |
WorkflowExecutionID! |
— | — |
status |
String! |
— | — |
cancellationRequested |
Boolean! |
— | — |
generation |
String |
— | — |
runner |
String |
— | — |
session |
String |
— | — |
authority |
String |
— | — |
revision |
String! |
— | — |
blocked |
Boolean! |
— | — |
rowVersion |
String |
— | — |
WorkflowExecutionSortField
STARTED_AT, COMPLETED_AT
WorkflowExecutionSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WorkflowExecutionSortField! |
— | — |
direction |
SortDirection! |
— | — |
WorkflowExecutionState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowExecutionID! |
— | — |
tenantId |
TenantID! |
— | — |
workflowId |
WorkflowID! |
— | — |
workflowName |
String |
— | — |
versionId |
WorkflowVersionID! |
— | — |
status |
ExecutionStatus! |
— | — |
cancellationRequested |
Boolean! |
— | — |
triggerType |
TriggerType! |
— | — |
input |
String! |
— | — |
output |
String |
— | — |
error |
WorkflowExecutionErrorOutput |
— | — |
startedAt |
ISO8601! |
— | — |
completedAt |
ISO8601 |
— | — |
durationMs |
Int |
— | — |
waitingNodeId |
String |
— | — |
currentWave |
Int! |
— | — |
totalWaves |
Int! |
— | — |
triggeredBySystem |
String |
— | — |
workflow |
WorkflowState |
— | — |
version |
WorkflowVersionState |
— | — |
trigger |
WorkflowTriggerState |
— | — |
steps |
[WorkflowExecutionStepState!]! |
— | — |
stepStatuses |
[WorkflowStepStatusSummary!]! |
— | — |
triggeredByUser |
UserState |
— | — |
WorkflowExecutionStepState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowExecutionStepID! |
— | — |
executionId |
WorkflowExecutionID! |
— | — |
nodeId |
String! |
— | — |
nodeName |
String! |
— | — |
nodeType |
String! |
— | — |
wave |
Int! |
— | — |
status |
StepStatus! |
— | — |
input |
String! |
— | — |
output |
String |
— | — |
error |
String |
— | — |
startedAt |
ISO8601 |
— | — |
completedAt |
ISO8601 |
— | — |
durationMs |
Int |
— | — |
retryCount |
Int! |
— | — |
maxRetries |
Int |
— | — |
nextRetryAt |
ISO8601 |
— | — |
timeoutAt |
ISO8601 |
— | — |
waitingForDeviceId |
DeviceID |
— | — |
execution |
WorkflowExecutionState |
— | — |
WorkflowFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
StringFilter |
— | — |
isActive |
BoolFilter |
— | — |
createdAt |
DateFilter |
— | — |
updatedAt |
DateFilter |
— | — |
WorkflowNodeDefinition
| Field | Type | Default | Arguments |
|---|---|---|---|
timeoutSeconds |
Float |
— | — |
maxRetries |
Int |
— | — |
continueOnError |
Boolean |
— | — |
id |
String! |
— | — |
name |
String! |
— | — |
type |
WorkflowNodeType! |
— | — |
config |
WorkflowNodeConfigJSONScalar |
— | — |
position |
WorkflowNodePosition |
— | — |
WorkflowNodeDefinitionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
timeoutSeconds |
Float |
— | — |
maxRetries |
Int |
— | — |
continueOnError |
Boolean |
— | — |
id |
String! |
— | — |
name |
String! |
— | — |
type |
WorkflowNodeType! |
— | — |
config |
WorkflowNodeConfigJSONScalar |
— | — |
position |
WorkflowNodePositionInput |
— | — |
WorkflowNodePositionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
x |
Float! |
— | — |
y |
Float! |
— | — |
WorkflowNodeRunStats
| Field | Type | Default | Arguments |
|---|---|---|---|
nodeId |
String! |
— | — |
runs |
Int! |
— | — |
failed |
Int! |
— | — |
waiting |
Int! |
— | — |
skipped |
Int! |
— | — |
medianDurationMs |
Int |
— | — |
WorkflowNodeType
agent, agent_task, assert, condition, csv_parse, custom_workflow_action, delay, file_check, file_copy, file_delete, file_list, file_read, file_wait, file_write, for_each, graphql, http_call, http_request, impose_pdf, impose_plan, integration_action, invoke_edge_app, join, json_parse, log, logic, merge, message, microsql, ml_predict, mqtt_publish, pdf_preflight, pdf_render, pdf_separations, producibility_audit, regex, run_report, script, set_variable, split, sql_query, switch, task, transform, yaml_parse
WorkflowPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
workflow |
WorkflowState |
— | — |
errors |
[FieldError!]! |
— | — |
WorkflowRunBucket
| Field | Type | Default | Arguments |
|---|---|---|---|
start |
ISO8601! |
— | — |
total |
Int! |
— | — |
failed |
Int! |
— | — |
WorkflowRunHealth
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
WorkflowID! |
— | — |
failed |
Int! |
— | — |
waiting |
Int! |
— | — |
lastStatus |
ExecutionStatus |
— | — |
lastStartedAt |
ISO8601 |
— | — |
WorkflowRunStats
| Field | Type | Default | Arguments |
|---|---|---|---|
total |
Int! |
— | — |
byStatus |
[WorkflowRunStatusCount!]! |
— | — |
medianDurationMs |
Int |
— | — |
p95DurationMs |
Int |
— | — |
buckets |
[WorkflowRunBucket!]! |
— | — |
nodes |
[WorkflowNodeRunStats!]! |
— | — |
WorkflowRunStatusCount
| Field | Type | Default | Arguments |
|---|---|---|---|
status |
ExecutionStatus! |
— | — |
count |
Int! |
— | — |
WorkflowSerializationFormat
XML, YAML, JSON
WorkflowSortField
NAME, CREATED_AT, UPDATED_AT
WorkflowSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WorkflowSortField! |
— | — |
direction |
SortDirection! |
— | — |
WorkflowState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowID! |
— | — |
tenantId |
TenantID! |
— | — |
name |
String! |
— | — |
description |
String |
— | — |
currentVersionId |
WorkflowVersionID |
— | — |
botUserId |
UserID |
— | — |
defaultNodeTimeoutSeconds |
Int |
— | — |
isActive |
Boolean! |
— | — |
createdAt |
ISO8601! |
— | — |
updatedAt |
ISO8601! |
— | — |
WorkflowStepStatusSummary
| Field | Type | Default | Arguments |
|---|---|---|---|
nodeId |
String! |
— | — |
status |
StepStatus! |
— | — |
wave |
Int |
— | — |
WorkflowTriggerPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
trigger |
WorkflowTriggerState |
— | — |
errors |
[FieldError!]! |
— | — |
WorkflowTriggerState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowTriggerID! |
— | — |
tenantId |
TenantID! |
— | — |
workflowId |
WorkflowID! |
— | — |
versionId |
WorkflowVersionID |
— | — |
name |
String! |
— | — |
config |
TriggerConfig! |
— | — |
isEnabled |
Boolean! |
— | — |
concurrencyPolicy |
ConcurrencyPolicy! |
— | — |
maxConcurrentExecutions |
Int |
— | — |
createdAt |
String! |
— | — |
updatedAt |
String! |
— | — |
WorkflowVariableDefinition
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
type |
String! |
— | — |
defaultValue |
String |
— | — |
description |
String |
— | — |
WorkflowVariableDefinitionInput
| Field | Type | Default | Arguments |
|---|---|---|---|
name |
String! |
— | — |
type |
String! |
— | — |
defaultValue |
String |
— | — |
description |
String |
— | — |
WorkflowVersionConnection
| Field | Type | Default | Arguments |
|---|---|---|---|
edges |
[WorkflowVersionEdge!]! |
— | — |
pageInfo |
PageInfo! |
— | — |
totalCount |
Int |
— | — |
WorkflowVersionEdge
| Field | Type | Default | Arguments |
|---|---|---|---|
node |
WorkflowVersionState! |
— | — |
cursor |
String! |
— | — |
WorkflowVersionFilterInput
| Field | Type | Default | Arguments |
|---|---|---|---|
workflowId |
IDFilter |
— | — |
isValid |
BoolFilter |
— | — |
createdAt |
DateFilter |
— | — |
WorkflowVersionPayload
| Field | Type | Default | Arguments |
|---|---|---|---|
version |
WorkflowVersionState |
— | — |
errors |
[FieldError!]! |
— | — |
WorkflowVersionSortField
VERSION, CREATED_AT
WorkflowVersionSortInput
| Field | Type | Default | Arguments |
|---|---|---|---|
field |
WorkflowVersionSortField! |
— | — |
direction |
SortDirection! |
— | — |
WorkflowVersionSource
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowVersionID! |
— | — |
workflowId |
WorkflowID! |
— | — |
sourceXML |
String! |
— | — |
version |
Int! |
— | — |
validationWarnings |
[String!]! |
— | — |
WorkflowVersionSourcePayload
| Field | Type | Default | Arguments |
|---|---|---|---|
version |
WorkflowVersionSource |
— | — |
errors |
[FieldError!]! |
— | — |
WorkflowVersionState
| Field | Type | Default | Arguments |
|---|---|---|---|
id |
WorkflowVersionID! |
— | — |
workflowId |
WorkflowID! |
— | — |
tenantId |
TenantID! |
— | — |
version |
Int! |
— | — |
definition |
WorkflowDefinition! |
— | — |
validationWarnings |
[String!]! |
— | — |
sourceXML |
String |
— | — |
isValid |
Boolean! |
— | — |
validationErrors |
[String!]! |
— | — |
createdAt |
ISO8601! |
— | — |
serialized |
String! |
— | format: WorkflowSerializationFormat! |
Published platform manual · revision bbfd3a9056d5