Skip to content

Query ​

Type: Object

Fields ​

NameTypeArgsDescriptionDeprecated
aggregateComponentsComponentAggregate!filter: ComponentFilterInputAggregate components with optional filtering. Returns count, sum, avg, min, max. Requires component:list permission.
aggregateJobsJobAggregate!filter: JobFilterInputAggregate jobs with optional filtering. Returns count, sum, avg, min, max. Requires job:list permission.
aggregateMetricPointsMetricAggregatePointsResult!input: AggregateMetricPointsInput!Aggregate metric data points into time buckets with configurable statistics. Automatically routes to pre-computed continuous aggregates for HOUR/DAY/WEEK/MONTH intervals. Supports gap-filling (LOCF/interpolation), time-weighted averages, and counter delta/rate via Toolkit. For counter metrics, computes delta (last-first) per bucket instead of average. Requires metric:read permission.
aggregateOperationsOperationAggregate!filter: OperationFilterInputAggregate operations with optional filtering. Returns count, sum, avg, min, max. Requires operation:list permission.
allWorkflowTriggers[WorkflowTriggerState!]!List all triggers for the current tenant. Requires workflow:list permission.
auditProductionAuditVerdictOutput!input: AuditProductionInput!Audit in-flight production for a job: evaluate current progress against the production DAG to detect waste, yield shortfalls, duration overruns, and item-level failures with downstream cascade analysis. Requires job:read permission.
auditProductionEnrichedAuditVerdictOutput!input: AuditProductionInput!Enriched production audit: same as auditProduction but additionally includes work center baseline metrics, production cell rankings, and live in-flight performance from progress_points hourly aggregates. Returns the same AuditVerdictOutput type with enrichments and livePerformance fields populated.
chatAIAvailabilityChatAIAvailability!Check if AI chat features are available for the current tenant.
compareMetricsMetricComparisonResult!input: CompareMetricsInput!Compare multiple metrics side-by-side over the same time range and interval. Returns time-bucketed aggregates and summary statistics for each metric. Supports 2-10 metrics per request. Requires metric:read permission.
conceptConceptid: ConceptID!Fetch a single concept by ID. Requires concept:read permission.
conceptsConceptConnection!after: String
filter: ConceptFilterInput
first: Int
sort: [ConceptSortInput!]
List the tenant's concepts with pagination. Requires concept:list permission.
controllerConnectionStatusBridgeConnectionStatus!id: ControllerID!Check whether a controller has an active bridge connection. Requires controller:read permission.
controllerJMFConfigControllerJMFConfigStatecontrollerId: ControllerID!Read a controller's JMF endpoint configuration. Requires controller:read.
customerAccountSummaryCustomerAccountSummaryPayload!customerId: CustomerID!
fromDate: String
toDate: String
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
dailyDispatchManifestDailyDispatchManifestPayload!date: String!Fetch all shipments for a given date with packages, items, and order details. Requires shipment:list.
dataRecordsBySchemaDataRecordConnection!after: String
first: Int
input: DataRecordsBySchemaInput!
List data records for a schema with pagination. Requires datarecord:read permission.
dataRecordsByTaggableDataRecordConnection!after: String
first: Int
input: DataRecordsByTaggableInput!
List data records tagged to a specific entity with pagination. Requires datarecord:read permission.
dataSchemasDataSchemaConnection!after: String
first: Int
List all data schemas for the current tenant with pagination. Requires dataschema:read permission.
describeQuerySchemaQuerySchemaPayload!input: DescribeQuerySchemaInput!Analyze a MicroSQL query and return the inferred result schema (column names, data types) without executing it. Returns validation errors with typo-correcting suggestions if the query is invalid. Requires :list permission on at least one table's resource.
downsampleMetricPointsMetricDownsampleResult!input: MetricDownsampleInput!Downsample metric data points for efficient visualization. Uses the Largest Triangle Three Buckets (LTTB) algorithm to preserve the visual shape of the time series while reducing point count. Optionally preserves gaps in data via gp_lttb(). Uses Toolkit lttb() / gp_lttb(). Requires metric:read permission.
evaluateProducibilityProducibilityResultOutput!input: EvaluateProducibilityInput!Evaluate whether a component can be produced by the given work centers
exportMLModelConfigExportMLModelConfigPayload!input: ExportMLModelConfigInput!Export an ML model config as JSON or YAML. Requires mlmodelconfig:read permission.
extractProductionExtractProductionPayload!input: ExtractProductionInput!Extract ISO 19593-1 production steps from supplied PDF bytes inline (not persisted) — inspect before creating Operations. Requires operation:read permission.
folderFolderid: FolderID!A single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.
foldersFolderConnection!after: String
filter: FolderFilterInput
first: Int
sort: [FolderSortInput!]
Folders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.
fulfillmentImpact[GraphNode!]!direction: String
entityId: ID!
maxDepth: Int
Entities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.
fulfillmentTraceGraphTrace!direction: String
entityId: ID!
maxDepth: Int
Lineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.
generateDefaultDataQueryStringtopic: String!Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
getAddressAddressStateid: AddressID!Fetch a single address by ID. Requires address:read permission.
getAddressByAddressStateexternalId: StringFetch an address by external ID. Requires address:read permission.
getAIAdapterAIAdapterOutputid: AIAdapterID!Fetch an AI adapter by ID. Requires aiadapter:read permission.
getAIAgentAIAgentStateid: AIAgentID!Fetch an AI agent by ID. Requires aiAgent:read permission.
getBusinessUnitBusinessUnitStateid: BusinessUnitID!Fetch a single business unit by ID. Requires businessunit:read permission.
getBusinessUnitByBusinessUnitStatecode: String
externalId: String
Fetch a business unit by external ID or code. Requires businessunit:read permission.
getCapabilityCapabilityStateid: CapabilityID!Fetch a single capability by id, scoped to the caller's tenant. Null when no visible capability has that id. Requires capability:read permission.
getCarrierCarrierStateid: CarrierID!Fetch a carrier by ID. Requires carrier:read permission.
getChatSessionChatSessionStateid: ChatSessionID!Fetch a chat session by ID. Requires chatsession:read permission.
getComponentComponentStateid: ComponentID!Fetch a component by ID. Requires component:read permission.
getComponentArtworkFileComponentArtworkFileStateid: ComponentArtworkFileID!Fetch a component artwork file reference by ID. Requires componentArtworkFile:read permission.
getComponentByComponentStateexternalId: StringFetch a component by external ID. Requires component:read permission.
getComponentGroupComponentGroupStateid: ComponentGroupID!Fetch a component section by ID. Requires componentGroup:read permission.
getContactByContactStateemail: String
externalId: String
Fetch a contact by external ID or email. Requires contact:read permission.
getControllerControllerStateid: ControllerID!Fetch a single controller by ID. Requires controller:read permission.
getControllerPolicyControllerPolicyStateid: ControllerPolicyID!Fetch a controller policy by its ID. Requires controller_policy:read permission.
getControllerPolicyByControllerControllerPolicyStatecontrollerId: ControllerID!Fetch a controller's policy by the controller ID (the natural key). Returns null if no policy is configured (default-deny).
getCostCategoryCostCategoryStateid: CostCategoryID!Fetch a single cost category by ID. Requires costcategory:read permission.
getCostCategoryByCostCategoryStatecode: String
externalId: String
Fetch a cost category by external ID or code. Requires costcategory:read permission.
getCostCenterCostCenterStateid: CostCenterID!Fetch a single cost center by ID. Requires costcenter:read permission.
getCostCenterByCostCenterStatecode: String
externalId: String
Fetch a cost center by external ID or code. Requires costcenter:read permission.
getCostRateCostRateStateid: CostRateID!Fetch a single cost rate by ID. Requires costrate:read permission.
getCustomAppCustomAppStateid: CustomAppID!Fetch a custom app by ID. Requires customapp:read permission.
getCustomAppByHandleCustomAppStatehandle: String!Fetch a custom app by handle. Requires customapp:read permission.
getCustomAppVersionCustomAppVersionStateid: CustomAppVersionID!Fetch a custom app version by ID. Requires customapp:read permission.
getCustomDataContainerCustomDataContainerStateinput: CustomDataContainerByIdInput!Fetch a custom data container by ID. Requires customapp:read permission.
getCustomerCustomerStateid: CustomerID!Fetch a single customer by ID. Requires customer:read permission.
getCustomerByCustomerStateexternalId: StringFetch a customer by external ID. Requires customer:read permission.
getCustomWorkflowActionCustomWorkflowActionStateid: CustomWorkflowActionID!Fetch a single custom action by id within the caller's tenant. Returns null when no such action exists. Requires customWorkflowAction:read permission.
getDashboardDashboardStateid: DashboardID!Fetch a dashboard by ID with its cards. Requires dashboard:read permission.
getDashboardCardDashboardCardStatecardId: DashboardCardID!
dashboardId: DashboardID!
Fetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.
getDataClipDataClipStateid: DataClipID!Get a data clip by ID
getDataRecordDataRecordStateinput: DataRecordByIdInput!Fetch a data record by ID. Requires datarecord:read permission.
getDataSchemaDataSchemaStateinput: DataSchemaByIdInput!Fetch a data schema by ID. Requires dataschema:read permission.
getDataSchemaByNameDataSchemaStateinput: DataSchemaByNameInput!Fetch a data schema by name. Requires dataschema:read permission.
getDeviceDeviceStateid: DeviceID!Fetch a single device by ID. Requires device:read permission.
getDropboxBackendDropboxBackendid: StorageBackendID!Fetch one storage backend as a Dropbox backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not Dropbox — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getEdgeAppEdgeAppStateid: EdgeAppID!Fetch a edge app by ID. Requires edge_app:read permission.
getEdgeAppEventEdgeAppEventStateid: EdgeAppEventID!Fetch a edge app event by ID. Requires edge_app_event:read permission.
getEdgeAppInstallationEdgeAppInstallationStateid: EdgeAppInstallationID!Fetch a edge app installation by ID. Requires edge_app_installation:read permission.
getEstimateEstimateStateid: EstimateID!Fetch an estimate by ID. Requires estimate:read permission.
getEstimateByEstimateStateexternalId: StringFetch an estimate by external ID. Requires estimate:read permission.
getEstimateLineEstimateLineStateid: EstimateLineID!Fetch an estimate line by ID. Requires estimate:read permission.
getExecutionWorkflowExecutionStateid: WorkflowExecutionID!Fetch a single workflow execution by ID. Requires workflow:read permission.
getExecutionSteps[WorkflowExecutionStepState!]!executionId: WorkflowExecutionID!Fetch all steps for a workflow execution. Requires workflow:read permission.
getExternalSchemaExternalSchemaStateid: ExternalSchemaID!Fetch an external schema by ID. Requires externalSchema:read permission.
getFileFileStateid: FileID!Fetch a file by ID. Requires file:read permission.
getFTPBackendFTPBackendid: StorageBackendID!Fetch one storage backend as an FTP backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not FTP — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getGoogleDriveBackendGoogleDriveBackendid: StorageBackendID!Fetch one storage backend as a Google Drive backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not Google Drive — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getHostPathBackendHostPathBackendid: StorageBackendID!Fetch one storage backend as a host-path backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not host-path — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getImpositionSpecImpositionSpecStateid: ImpositionSpecID!Fetch an imposition spec by ID. Requires impositionSpec:read permission.
getIncomingWebhookIncomingWebhookStateid: IncomingWebhookID!Fetch an incoming webhook by ID. Requires incomingWebhook:read permission.
getIntegrationDataContainerIntegrationDataContainerStateinput: IntegrationDataContainerByIdInput!Fetch an integration data container by ID. Requires integrationDataContainer:read permission.
getIntegrationDataContainerByNameIntegrationDataContainerStateinput: IntegrationDataContainerByNameInput!Fetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.
getIntegrationDefinitionIntegrationDefinitionStateid: IntegrationDefinitionID!Fetch a single integration definition by ID. Requires integrationDefinition:read permission.
getIntegrationInstanceIntegrationInstanceStateid: IntegrationInstanceID!Fetch a single integration instance by ID. Requires integrationInstance:read permission.
getInvoiceInvoiceStateid: InvoiceID!Fetch a single invoice by ID. Requires invoice:read permission.
getInvoiceLineInvoiceLineStateid: InvoiceLineID!Fetch a single invoice line by ID. Requires invoice:read permission.
getJobJobStateid: JobID!Fetch a job by ID. Requires job:read permission.
getJobByJobStateexternalId: StringFetch a job by external ID. Requires job:read permission.
getJobGroupJobGroupStateid: JobGroupID!Fetch a job group by ID. Requires jobGroup:read permission.
getJobMaterialReservationJobMaterialReservationStateid: JobMaterialReservationID!Fetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.
getJourneyJourneyid: JourneyID!Fetch a single journey by ID, if the caller may see it.
getJourneyByHandleJourneyhandle: String!Fetch a journey by its stable handle (deep links / anchored launches), if the caller may see it.
getJourneyVersionJourneyVersionid: JourneyVersionID!Fetch one journey version by ID. Returns null when the journey is not visible to the caller, and when the version is still an open draft and the caller is not its author — matching what listJourneyVersions would show.
getKioskModeInfoKioskModeInfo!Get kiosk mode information including accessible apps for the current user. Requires authentication.
getLuaSampleLuaSampleid: String!Fetch one Lua sample with its runnable source. Requires script:read.
getMagicQueryGraphQLMagicQueryOperation!query: QueryScalar!Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
getMagicQuerySchemaMagicQuerySchema!query: QueryScalar!Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getMetricMetricStateid: MetricID!Fetch a single metric by ID. Requires metric:read permission.
getMetricPointsMetricPointsResult!from: ISO8601
limit: Int
metricId: MetricID!
to: ISO8601
Query time-series data points for a metric. Returns a flat array ordered by timestamp, with summary stats. Requires metric:read permission.
getMilestoneMilestoneStateid: MilestoneID!Fetch a milestone by ID. Requires milestone:read permission.
getMilestoneByMilestoneStateexternalId: StringFetch a milestone by external ID. Requires milestone:read permission.
getMLModelConfigMLModelConfigOutputid: MLModelConfigID!Fetch an ML model config by ID. Requires mlmodelconfig:read permission.
getMLModelConfigVersionMLModelConfigVersionOutputid: MLModelConfigVersionID!Get a specific ML model config version by ID. Requires mlmodelconfig:read permission.
getNetworkNetworkStateid: NetworkID!Fetch a single network by ID. Requires network:read permission.
getNotificationGroupNotificationGroupStateid: NotificationGroupID!Fetch a notification group by ID. Requires notificationGroup:read permission.
getNotificationRecipientNotificationRecipientStateid: NotificationRecipientID!Fetch a notification recipient by ID. Requires notificationRecipient:read permission.
getOperationOperationStateid: OperationID!Fetch an operation by ID. Requires operation:read permission.
getOperationByOperationStateexternalId: StringFetch an operation by external ID. Requires operation:read permission.
getOperationCompletionOperationCompletionStateid: OperationCompletionID!Fetch an operation completion record by ID. Requires operation:read permission.
getOperationCompletionByOperationOperationCompletionStateoperationId: OperationID!Fetch the most recent completion record for an operation. Requires operation:read permission.
getOperationCostMappingOperationCostMappingStateid: OperationCostMappingID!Fetch a single operation cost mapping by ID. Requires costcategory:read permission.
getOperationParameterSchemaJSONkind: String!Returns the JSON Schema (draft-07) for the parameters field of the given operation kind, or null if no schema is defined for that kind. Use this to drive dynamic form generation on the client. Requires operation:read permission.
getOptimizationRunOptimizationRunStateid: OptimizationRunID!Get an optimization run by ID. Requires optimizationRun:read permission.
getOrderOrderStateid: OrderID!Fetch an order by ID. Requires order:read permission.
getOrderLineOrderLineStateid: OrderLineID!Fetch an order line by ID. Requires order:read permission.
getPaymentPaymentStateid: PaymentID!Fetch a single payment by ID. Requires payment:read permission.
getPreflightReportPreflightReportStateid: PreflightReportID!Fetch a preflight report by ID. Requires preflightReport:read permission.
getPrepressOperationPrepressOperationStateid: PrepressOperationID!Fetch a prepress operation by ID. Requires prepressOperation:read permission.
getPriceBracketPriceBracketStateid: PriceBracketID!Fetch a single price bracket by ID. Requires priceBracket:read permission.
getProductProductStateid: ProductID!Fetch a single product by ID. Requires product:read permission.
getProductionCellProductionCellStateid: ProductionCellID!Fetch a single production cell by id, scoped to the caller's tenant. Null when no such production cell exists. Requires productionCell:read permission.
getProductionPlanProductionPlanWithChildrenid: ProductionPlanID!A single production plan with all of its planned operations and edges. Null when no such plan exists in the caller's tenant. Requires productionPlan:read permission.
getProductionReportProductionReportStateid: ProductionReportID!Fetch a production report by ID. Requires productionReport:read.
getProductTemplateProductTemplateStateid: ProductTemplateID!Fetch a product template by ID. Requires productTemplate:read permission.
getProductTemplateVersionProductTemplateVersionStatetemplateId: ProductTemplateID!
version: Int!
Fetch a specific published version. Requires productTemplate:read permission.
getProtobufSchemaProtobufSchemaStateinput: ProtobufSchemaByIdInput!Fetch a protobuf schema by ID. Requires protobufSchema:read permission.
getProtobufSchemaByNameProtobufSchemaStateinput: ProtobufSchemaByNameInput!Fetch a protobuf schema by name. Requires protobufSchema:read permission.
getPurchaseOrderPurchaseOrderStateid: PurchaseOrderID!Fetch a single purchase order by ID. Requires purchaseOrder:read permission.
getPurchaseOrderLinePurchaseOrderLineStateid: PurchaseOrderLineID!Fetch a single purchase order line by ID. Requires purchaseOrder:read permission.
getRecordedCostRecordedCostStateid: RecordedCostID!Fetch a single recorded cost by ID. Requires recordedcost:read permission.
getS3BackendS3Backendid: StorageBackendID!Fetch one storage backend as an S3 backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not S3 — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
getScheduleScenarioScheduleScenarioStateid: ScheduleScenarioID!Fetch a single schedule scenario by id, or null when it does not exist. Requires scheduleScenario:read permission.
getScriptScriptStateid: ScriptID!Fetch a script by ID. Requires script:read permission.
getScriptByNameScriptStatename: String!Fetch a script by name. Requires script:read permission.
getScriptVersionScriptVersionStatescriptId: ScriptID!
version: Int!
Fetch one version of a script. Requires script:read permission.
getSharedResourceSharedResourceEnvelopeid: SharedResourceTemplateID!Fetch a single catalog template's metadata by id. Returns null when no such template exists in the catalog. Requires sharedResource:read permission.
getShiftDefinitionShiftDefinitionStateid: ShiftDefinitionID!Fetch a single shift definition by id, or null when no definition with that id exists in the caller's tenant. Requires shiftDefinition:read permission.
getShipmentShipmentStateid: ShipmentID!Fetch a shipment by ID. Requires shipment:read permission.
getShipmentItemShipmentItemStateid: ShipmentItemID!Fetch a shipment item by ID. Requires shipment:read permission.
getShipmentPackageShipmentPackageStateid: ShipmentPackageID!Fetch a shipment package by ID. Requires shipment:read permission.
getStorageBackendStorageBackendOutputid: StorageBackendID!Fetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.
getSubstrateSubstrateStateid: SubstrateID!Fetch a substrate by ID. Requires substrate:read permission.
getSubstrateBySubstrateStateexternalId: StringFetch a substrate by external ID. Requires substrate:read permission.
getSubstrateTemplateLineSubstrateTemplateLineStateid: SubstrateTemplateLineID!Fetch a single substrate template line by ID. Requires substrateTemplateLine:read permission.
getSupplierSupplierStateid: SupplierID!Fetch a single supplier by ID. Requires supplier:read permission.
getTaskTaskStateid: TaskID!Fetch a task by ID. Requires task:read permission.
getTaskEventsTaskEventConnection!after: String
first: Int
taskId: TaskID!
Fetch the audit trail for a task, paginated. Requires task:read permission.
getTaxCodeTaxCodeStateid: TaxCodeID!Fetch a single tax code by ID. Requires taxCode:read permission.
getTemplateTemplateStateid: TemplateID!Fetch a template by ID. Requires template:read permission.
getTemplateByHandleTemplateStatehandle: String!Fetch a template by handle. Requires template:read permission.
getTemplateVersionTemplateVersionStateid: TemplateVersionID!Fetch one template version by ID. Requires template:read permission.
getWarehouseLocationWarehouseLocationStateid: WarehouseLocationID!Fetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.
getWarehouseStockWarehouseStockStateid: WarehouseStockID!Fetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.
getWarehouseTransferWarehouseTransferStateid: WarehouseTransferID!Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.
getWorkCenterWorkCenterStateid: WorkCenterID!Fetch a single work center by id, scoped to the caller's tenant. Null when no such work center exists. Requires workCenter:read permission.
getWorkCenterByWorkCenterStateexternalId: StringFetch a work center by external ID. Requires workCenter:read permission.
getWorkCenterCapabilityWorkCenterCapabilityStateid: WorkCenterCapabilityID!One capability assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
getWorkCenterDeviceWorkCenterDeviceStateid: WorkCenterDeviceID!One device binding by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
getWorkCenterShiftProfileWorkCenterShiftProfileStateid: WorkCenterShiftProfileID!One shift profile assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
getWorkflowWorkflowStateid: WorkflowID!Fetch a single workflow by ID. Requires workflow:read permission.
getWorkflowSchemaString!Get the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.
getWorkflowVersionWorkflowVersionStateid: WorkflowVersionID!Fetch a single workflow version by ID. Requires workflow:read permission.
getWorkspaceWorkspaceid: WorkspaceID!Fetch a single workspace by ID, if the caller may see it.
getWorkspaceByHandleWorkspacehandle: String!Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.
getWorkspaceVersionWorkspaceVersionid: WorkspaceVersionID!Fetch one workspace version by ID. Returns null when the workspace is not visible to the caller, and when the version is still an open draft and the caller is not its author — matching what listWorkspaceVersions would show.
iacGuides[IaCGuide!]!Every authoring guide, for a tool that syncs them to a folder. Intended for schema pull to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
iacSchemaIaCSchemaDocument!The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentIaCSchemaDocumentPayload!ref: String!Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateIaCValidationResult!role: String
source: String!
validator: String!
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
integrationInstanceTimers[IntegrationInstanceTimer!]!instanceId: IntegrationInstanceID!List the timers declared in the integration manifest backing this instance. Requires integrationInstance:read permission.
isKioskUserBoolean!Check if the current user is in kiosk mode. Requires authentication.
jobCostingSummaryJobCostingSummaryPayload!jobId: JobID!Get a costing summary for a job including material and operation costs. Requires job:read.
knowledgeNoteKnowledgeNoteid: KnowledgeNoteID!Fetch a single knowledge note by ID. Requires knowledgeNote:read permission.
knowledgeNotesKnowledgeNoteConnection!after: String
filter: KnowledgeNoteFilterInput
first: Int
sort: [KnowledgeNoteSortInput!]
List knowledge notes with pagination and filtering. A direct query over the store; for situational relevance use retrieveKnowledge. Requires knowledgeNote:list permission.
latestProgressProgressPointStateoperationId: OperationID!Get the most recent progress snapshot for an operation. Requires progressPoint:read permission.
listAddressesAddressConnection!after: String
before: String
filter: AddressFilterInput
first: Int
last: Int
sort: [AddressSortInput!]
List addresses with pagination. Requires address:list permission.
listAIAdaptersAIAdapterConnection!after: String
before: String
filter: AIAdapterFilterInput
first: Int
last: Int
sort: [AIAdapterSortInput!]
List AI adapters with pagination and filtering. Requires aiadapter:list permission.
listAIAgentsAIAgentConnection!after: String
filter: AIAgentFilterInput
first: Int
sort: [AIAgentSortInput!]
List AI agents with pagination. Requires aiAgent:list permission.
listAvailableActionsAvailableActionConnection!after: String
first: Int
The tenant's unified action catalog: every active custom action plus every action declared by an active integration instance, ordered by label and keyset-paginated. Inactive custom actions are omitted. Requires customWorkflowAction:list permission.
listBusinessUnitsBusinessUnitConnection!after: String
before: String
filter: BusinessUnitFilterInput
first: Int
last: Int
sort: [BusinessUnitSortInput!]
List business units with pagination. Requires businessunit:list permission.
listCapabilitiesCapabilityConnection!after: String
before: String
filter: CapabilityFilterInput
first: Int
last: Int
sort: [CapabilitySortInput!]
List the capabilities visible to the caller's tenant — the tenant's own capabilities plus any non-tenant-scoped ones. Requires capability:list permission.
listCarriersCarrierConnection!after: String
filter: CarrierFilterInput
first: Int
sort: [CarrierSortInput!]
List carriers with pagination. Requires carrier:list permission.
listChatSessionsChatSessionConnection!after: String
before: String
filter: ChatSessionFilterInput
first: Int
last: Int
sort: ChatSessionSortInput
List chat sessions with pagination and filtering. Requires chatsession:list permission.
listComponentArtworkFiles[ComponentArtworkFileState!]!componentId: ComponentID!List artwork file references for a component. Requires componentArtworkFile:list permission.
listComponentGroupsComponentGroupConnection!after: String
first: Int
jobId: JobID
List component sections, optionally scoped to a job. Requires componentGroup:list permission.
listComponentsComponentConnection!after: String
before: String
filter: ComponentFilterInput
first: Int
last: Int
sort: [ComponentSortInput!]
List components with pagination and filtering. Requires component:list permission.
listContactsContactConnection!after: String
before: String
filter: ContactFilterInput
first: Int
last: Int
sort: [ContactSortInput!]
List contacts with pagination. Requires contact:list permission.
listControllerPoliciesControllerPolicyConnection!after: String
before: String
filter: ControllerPolicyFilterInput
first: Int
last: Int
sort: [ControllerPolicySortInput!]
List controller policies with pagination. Requires controller_policy:list permission.
listControllersControllerConnection!after: String
before: String
filter: ControllerFilterInput
first: Int
last: Int
sort: [ControllerSortInput!]
List controllers with pagination. Requires controller:list permission.
listControllerTokensControllerTokenConnection!after: String
before: String
filter: ControllerTokenFilterInput
first: Int
last: Int
sort: [ControllerTokenSortInput!]
List controller tokens with pagination. Requires controller_token:list permission.
listCostCategoriesCostCategoryConnection!after: String
before: String
filter: CostCategoryFilterInput
first: Int
last: Int
sort: [CostCategorySortInput!]
List cost categories with pagination. Requires costcategory:list permission.
listCostCentersCostCenterConnection!after: String
before: String
filter: CostCenterFilterInput
first: Int
last: Int
sort: [CostCenterSortInput!]
List cost centers with pagination. Requires costcenter:list permission.
listCostRatesCostRateConnection!after: String
before: String
filter: CostRateFilterInput
first: Int
last: Int
sort: [CostRateSortInput!]
List cost rates with pagination. Requires costrate:list permission.
listCustomAppsCustomAppConnection!after: String
before: String
filter: CustomAppFilterInput
first: Int
last: Int
sort: [CustomAppSortInput!]
List custom apps with pagination and filtering. Requires customapp:list permission.
listCustomAppTeamsCustomAppTeamConnection!after: String
filter: CustomAppTeamFilterInput
first: Int
List custom app team bindings. Requires customappteam:read permission.
listCustomAppUsersCustomAppUserConnection!after: String
filter: CustomAppUserFilterInput
first: Int
List custom app user bindings. Requires customappuser:read permission.
listCustomAppVersionsCustomAppVersionConnection!after: String
customAppId: CustomAppID!
filter: CustomAppVersionFilterInput
first: Int
sort: CustomAppVersionSortInput
List versions for a custom app. Requires customapp:read permission.
listCustomDataContainersByAppCustomDataContainerConnection!after: String
first: Int
input: CustomDataContainersByAppInput!
List containers for a custom app with pagination. Requires customapp:read permission.
listCustomDataContainersByTaggableCustomDataContainerConnection!after: String
first: Int
input: CustomDataContainersByTaggableInput!
List containers tagged to a specific entity with pagination. Requires customapp:read permission.
listCustomerPriceOverridesCustomerPriceOverrideConnection!after: String
filter: CustomerPriceOverrideFilterInput
first: Int
sort: [CustomerPriceOverrideSortInput!]
List customer price overrides. Requires customerPriceOverride:list permission.
listCustomersCustomerConnection!after: String
before: String
filter: CustomerFilterInput
first: Int
last: Int
sort: [CustomerSortInput!]
List customers with pagination, filtering, and sorting. Requires customer:list permission.
listCustomWorkflowActionsCustomWorkflowActionConnection!after: String
filter: CustomWorkflowActionFilterInput
first: Int
sort: [CustomWorkflowActionSortInput!]
List the caller's tenant's custom actions, filtered and sorted. Requires customWorkflowAction:list permission.
listDashboardsDashboardConnection!after: String
before: String
filter: DashboardFilterInput
first: Int
last: Int
sort: [DashboardSortInput!]
List dashboards visible to the current user. Returns personal dashboards owned by the user and shared dashboards. Requires dashboard:list permission.
listDataChangeEventTopics[DataChangeEventGroup!]!List all valid data change event topics, grouped by resource. Requires authentication.
listDataClipsDataClipConnection!after: String
filter: DataClipFilterInput
first: Int
sort: [DataClipSortInput!]
List data clips for the current tenant
listDataRecordsDataRecordConnection!after: String
filter: DataRecordFilterInput!
first: Int
sort: [DataRecordSortInput!]
List data records with pagination. Requires datarecord:list permission.
listDataSchemasDataSchemaConnection!after: String
filter: DataSchemaFilterInput
first: Int
sort: [DataSchemaSortInput!]
List data schemas with pagination. Requires dataschema:list permission.
listDevicesDeviceConnection!after: String
before: String
filter: DeviceFilterInput
first: Int
last: Int
sort: [DeviceSortInput!]
List devices with pagination. Requires device:list permission.
listDeviceTokensDeviceTokenConnection!after: String
before: String
filter: DeviceTokenFilterInput
first: Int
last: Int
sort: [DeviceTokenSortInput!]
List device tokens with pagination. Requires device_token:list permission.
listEdgeAppEventsEdgeAppEventConnection!after: String
before: String
filter: EdgeAppEventFilterInput
first: Int
last: Int
sort: [EdgeAppEventSortInput!]
List edge app events with pagination. Requires edge_app_event:list permission.
listEdgeAppInstallationsEdgeAppInstallationConnection!after: String
before: String
filter: EdgeAppInstallationFilterInput
first: Int
last: Int
sort: [EdgeAppInstallationSortInput!]
List edge app installations with pagination. Requires edge_app_installation:list permission.
listEdgeAppsEdgeAppConnection!after: String
before: String
filter: EdgeAppFilterInput
first: Int
last: Int
sort: [EdgeAppSortInput!]
List edge apps with pagination. Requires edge_app:list permission.
listEstimateCostBreakdownsEstimateCostBreakdownConnection!after: String
estimateLineId: EstimateLineID!
first: Int
List cost breakdowns for an estimate line. Requires estimate:read permission.
listEstimateLinesEstimateLineConnection!after: String
filter: EstimateLineFilterInput
first: Int
sort: [EstimateLineSortInput!]
List estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.
listEstimatesEstimateConnection!after: String
filter: EstimateFilterInput
first: Int
sort: [EstimateSortInput!]
List estimates with pagination, filtering, and sorting. Requires estimate:list permission.
listExecutionLogsExecutionLogConnection!after: String
contextId: String!
contextType: ExecutionLogContextType!
first: Int
level: ExecutionLogLevel
List execution log entries for a given context, newest first
listExecutionsWorkflowExecutionConnection!after: String
before: String
filter: WorkflowExecutionFilterInput
first: Int
last: Int
sort: [WorkflowExecutionSortInput!]
List workflow executions with pagination. Requires workflow:list permission.
listExternalSchemaEntriesExternalSchemaEntryConnection!after: String
filter: ExternalSchemaEntryFilterInput
first: Int
schemaId: ExternalSchemaID!
sort: [ExternalSchemaEntrySortInput!]
List entries for an external schema. Requires externalSchema:read permission.
listExternalSchemasExternalSchemaConnection!after: String
filter: ExternalSchemaFilterInput
first: Int
sort: [ExternalSchemaSortInput!]
List external schemas with pagination and filtering. Requires externalSchema:list permission.
listFilesFileConnection!after: String
filter: FileFilterInput
first: Int
sort: [FileSortInput!]
List files with pagination and filtering. Requires file:list permission.
listFoldPatternsFoldCatalogPayload!List all available fold patterns from the catalog. Requires authentication.
listImpositionSpecs[ImpositionSpecState!]!componentId: ComponentID!List imposition specs for a component. Requires impositionSpec:list permission.
listIncomingWebhooksIncomingWebhookConnection!after: String
before: String
filter: IncomingWebhookFilterInput
first: Int
last: Int
sort: [IncomingWebhookSortInput!]
List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.
listIntegrationDataContainersByInstanceIntegrationDataContainerConnection!after: String
first: Int
input: IntegrationDataContainersByInstanceInput!
List containers for an integration instance with pagination. Requires integrationDataContainer:list permission.
listIntegrationDataContainersByTaggableIntegrationDataContainerConnection!after: String
first: Int
input: IntegrationDataContainersByTaggableInput!
List containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.
listIntegrationDefinitionsIntegrationDefinitionConnection!after: String
before: String
filter: IntegrationDefinitionFilterInput
first: Int
last: Int
sort: [IntegrationDefinitionSortInput!]
List integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.
listIntegrationInstancesIntegrationInstanceConnection!after: String
before: String
filter: IntegrationInstanceFilterInput
first: Int
last: Int
sort: [IntegrationInstanceSortInput!]
List integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.
listIntegrationsIntegrationLatestConnection!after: String
before: String
filter: IntegrationDefinitionFilterInput
first: Int
last: Int
sort: [IntegrationDefinitionSortInput!]
List one row per integrationId — the latest version (highest semver, ties broken by createdAt). Drill into a row's versions via listIntegrationDefinitions filtered on integrationId. Requires integrationDefinition:list permission.
listInvoiceLinesInvoiceLineConnection!after: String
filter: InvoiceLineFilterInput
first: Int
sort: [InvoiceLineSortInput!]
List invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.
listInvoicesInvoiceConnection!after: String
filter: InvoiceFilterInput
first: Int
sort: [InvoiceSortInput!]
List invoices with pagination, filtering, and sorting. Requires invoice:list permission.
listJobGroupsJobGroupConnection!after: String
first: Int
orderId: OrderID
List job groups with pagination. Requires jobGroup:list permission.
listJobMaterialReservationsJobMaterialReservationConnection!after: String
filter: JobMaterialReservationFilterInput
first: Int
sort: [JobMaterialReservationSortInput!]
List material reservations with pagination. Requires jobMaterialReservation:list permission.
listJobsJobConnection!after: String
before: String
filter: JobFilterInput
first: Int
last: Int
sort: [JobSortInput!]
List jobs with pagination and filtering. Requires job:list permission.
listJourneysJourneyConnection!after: String
filter: JourneyFilterInput
first: Int
sort: [JourneySortInput!]
List the caller's visible journey library (own personal + their teams' + instance).
listJourneyVersionsJourneyVersionConnection!after: String
first: Int
journeyId: JourneyID!
List all versions of a journey, newest first (authoring history), if the caller may see it.
listLuaSamples[LuaSampleSummary!]!role: LuaScriptRole
tier: LuaSampleTier
List the platform's Lua sample scripts. Metadata only — fetch source with getLuaSample. Every sample is type-checked and executed by tests. Requires script:read.
listMagicQueries[MagicQueryInfo!]!Lists every available Magic Query noun with a short description and its options — the discovery entry point.
listMetricsMetricConnection!after: String
before: String
filter: MetricFilterInput
first: Int
last: Int
sort: [MetricSortInput!]
List metrics with pagination. Requires metric:list permission.
listMilestonesMilestoneConnection!after: String
before: String
filter: MilestoneFilterInput
first: Int
last: Int
sort: [MilestoneSortInput!]
List milestones with pagination and filtering. Requires milestone:list permission.
listMLModelConfigsMLModelConfigConnection!after: String
before: String
filter: MLModelConfigFilterInput
first: Int
last: Int
sort: [MLModelConfigSortInput!]
List ML model configs with pagination and filtering. Requires mlmodelconfig:list permission.
listMLModelConfigVersionsMLModelConfigVersionConnection!after: String
configId: MLModelConfigID!
first: Int
List versions for an ML model config, newest first, with pagination. Requires mlmodelconfig:read permission.
listNetworksNetworkConnection!after: String
before: String
filter: NetworkFilterInput
first: Int
last: Int
sort: [NetworkSortInput!]
List networks with pagination. Requires network:list permission.
listNotificationGroupsNotificationGroupConnection!after: String
filter: NotificationGroupFilterInput
first: Int
sort: [NotificationGroupSortInput!]
List notification groups with pagination. Requires notificationGroup:list permission.
listNotificationRecipientsNotificationRecipientConnection!after: String
filter: NotificationRecipientFilterInput
first: Int
sort: [NotificationRecipientSortInput!]
List notification recipients with pagination. Requires notificationRecipient:list permission.
listOperationCompletionsOperationCompletionConnection!after: String
before: String
filter: OperationCompletionFilterInput
first: Int
last: Int
sort: [OperationCompletionSortInput!]
List operation completion records with pagination. Requires operation:list permission.
listOperationCostMappingsOperationCostMappingConnection!after: String
filter: OperationCostMappingFilterInput
first: Int
sort: [OperationCostMappingSortInput!]
List operation cost mappings. Requires costcategory:list permission.
listOperationEdgesOperationEdgeConnection!after: String
first: Int
jobId: JobID!
List every operation dependency edge of a job, ordered by sortOrder ascending, with pagination. Returns an empty connection for a job with no edges. Requires operation:read permission.
listOperationItemEdgesOperationItemEdgeConnection!after: String
first: Int
jobId: JobID!
sourceOperationId: OperationID
targetOperationId: OperationID
List item-level dependency edges, with pagination. Filter by job and optionally by source/target operation. Requires operation:read permission.
listOperationItemsOperationItemConnection!after: String
first: Int
operationId: OperationID!
List operation items for an operation, sorted by sortOrder, with pagination. Requires operation:read permission.
listOperationsOperationConnection!after: String
before: String
filter: OperationFilterInput
first: Int
last: Int
sort: [OperationSortInput!]
List operations with pagination and filtering. Requires operation:list permission.
listOptimizationRunsOptimizationRunConnection!after: String
first: Int
scenarioId: ScheduleScenarioID!
List optimization runs for a scenario, paginated. Requires optimizationRun:list permission.
listOrderLinesOrderLineConnection!after: String
filter: OrderLineFilterInput
first: Int
sort: [OrderLineSortInput!]
List order lines with pagination. Requires order:list permission.
listOrdersOrderConnection!after: String
filter: OrderFilterInput
first: Int
sort: [OrderSortInput!]
List orders with pagination. Requires order:list permission.
listPaymentsPaymentConnection!after: String
filter: PaymentFilterInput
first: Int
sort: [PaymentSortInput!]
List payments with pagination. Requires payment:list permission.
listPreflightReports[PreflightReportState!]!componentId: ComponentID!List preflight reports for a component. Requires preflightReport:list permission.
listPrepressOperations[PrepressOperationState!]!componentId: ComponentID!List prepress operations for a component. Requires prepressOperation:list permission.
listPriceBracketsPriceBracketConnection!after: String
filter: PriceBracketFilterInput
first: Int
sort: [PriceBracketSortInput!]
List price brackets with pagination. Requires priceBracket:list permission.
listProductionCellsProductionCellConnection!after: String
before: String
filter: ProductionCellFilterInput
first: Int
last: Int
sort: [ProductionCellSortInput!]
List the tenant's production cells as a paginated connection, with optional filtering and sorting. Requires productionCell:list permission.
listProductionPlansProductionPlanConnection!after: String
first: Int
jobId: JobID!
Production plans of a job, newest version first, paginated. Plan headers only — no planned operations or edges. Requires productionPlan:read permission.
listProductionReportsProductionReportConnection!after: String
filter: ProductionReportFilterInput
first: Int
sort: ProductionReportSortInput
List production reports for the tenant, paginated. Requires productionReport:list.
listProductsProductConnection!after: String
filter: ProductFilterInput
first: Int
sort: [ProductSortInput!]
List products with pagination, filtering, and sorting. Requires product:list permission.
listProductTemplatesProductTemplateConnection!after: String
category: String
first: Int
isActive: Boolean
sku: String
status: String
List product templates with optional filters, sorted by name. Requires productTemplate:list permission.
listProductTemplateVersionsProductTemplateVersionConnection!after: String
first: Int
templateId: ProductTemplateID!
List published versions of a template with pagination. Requires productTemplate:read permission.
listProtobufSchemasProtobufSchemaConnection!after: String
filter: ProtobufSchemaFilterInput
first: Int
sort: [ProtobufSchemaSortInput!]
List protobuf schemas with pagination. Requires protobufSchema:list permission.
listPurchaseOrderLinesPurchaseOrderLineConnection!after: String
filter: PurchaseOrderLineFilterInput
first: Int
sort: [PurchaseOrderLineSortInput!]
List purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
listPurchaseOrdersPurchaseOrderConnection!after: String
filter: PurchaseOrderFilterInput
first: Int
sort: [PurchaseOrderSortInput!]
List purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
listRecordedCostsRecordedCostConnection!after: String
before: String
filter: RecordedCostFilterInput
first: Int
last: Int
sort: [RecordedCostSortInput!]
List recorded costs with pagination. Requires recordedcost:list permission.
listScheduleAllocationsScheduleAllocationConnection!after: String
before: String
filter: ScheduleAllocationFilterInput
first: Int
last: Int
scheduleScenarioId: ScheduleScenarioID!
sort: [ScheduleAllocationSortInput!]
List the allocations of one schedule scenario, ordered by start time by default. Requires scheduleScenario:read permission.
listScheduleScenariosScheduleScenarioConnection!after: String
before: String
filter: ScheduleScenarioFilterInput
first: Int
last: Int
sort: [ScheduleScenarioSortInput!]
List the caller's tenant's schedule scenarios as a keyset-paginated connection. Requires scheduleScenario:list permission.
listScriptsScriptConnection!after: String
before: String
filter: ScriptFilterInput
first: Int
last: Int
sort: [ScriptSortInput!]
List scripts with pagination and filtering. Requires script:list permission.
listScriptVersionsScriptVersionConnection!after: String
first: Int
scriptId: ScriptID!
A script's history, newest first. Requires script:read permission.
listShiftDefinitionsShiftDefinitionConnection!after: String
before: String
filter: ShiftDefinitionFilterInput
first: Int
last: Int
sort: [ShiftDefinitionSortInput!]
List the current tenant's shift definitions as a connection. Requires shiftDefinition:list permission.
listShipmentItemsShipmentItemConnection!after: String
filter: ShipmentItemFilterInput
first: Int
sort: [ShipmentItemSortInput!]
List shipment items with pagination. Requires shipment:list permission.
listShipmentPackagesShipmentPackageConnection!after: String
filter: ShipmentPackageFilterInput
first: Int
sort: [ShipmentPackageSortInput!]
List shipment packages with pagination. Requires shipment:list permission.
listShipmentsShipmentConnection!after: String
filter: ShipmentFilterInput
first: Int
sort: [ShipmentSortInput!]
List shipments with pagination. Requires shipment:list permission.
listStorageBackendsStorageBackendConnection!after: String
filter: StorageBackendFilterInput
first: Int
sort: [StorageBackendSortInput!]
List the calling tenant's storage backends. Requires storageBackend:list permission.
listSubstratesSubstrateConnection!after: String
filter: SubstrateFilterInput
first: Int
sort: [SubstrateSortInput!]
List substrates with pagination and filtering. Requires substrate:list permission.
listSubstrateTemplateLines[SubstrateTemplateLineState!]!productTemplateId: ProductTemplateID!List substrate template lines for a product template. Requires substrateTemplateLine:list permission.
listSuppliersSupplierConnection!after: String
filter: SupplierFilterInput
first: Int
sort: [SupplierSortInput!]
List suppliers with pagination, filtering, and sorting. Requires supplier:list permission.
listTasksTaskConnection!after: String
filter: TaskFilterInput
first: Int
sort: [TaskSortInput!]
List all tasks with pagination. Requires task:list permission.
listTaxCodesTaxCodeConnection!after: String
filter: TaxCodeFilterInput
first: Int
sort: [TaxCodeSortInput!]
List tax codes with pagination. Requires taxCode:list permission.
listTemplatesTemplateConnection!after: String
before: String
filter: TemplateFilterInput
first: Int
last: Int
sort: [TemplateSortInput!]
List templates with pagination and filtering. Requires template:list permission.
listTemplateVersionsTemplateVersionConnection!after: String
first: Int
templateId: TemplateID!
List versions of a template with pagination. Requires template:read permission.
listWarehouseLocationsWarehouseLocationConnection!after: String
filter: WarehouseLocationFilterInput
first: Int
sort: [WarehouseLocationSortInput!]
List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
listWarehouseStocksWarehouseStockConnection!after: String
filter: WarehouseStockFilterInput
first: Int
sort: [WarehouseStockSortInput!]
List the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.
listWarehouseTransfersWarehouseTransferConnection!after: String
filter: WarehouseTransferFilterInput
first: Int
sort: [WarehouseTransferSortInput!]
List the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.
listWorkCenterCapabilitiesWorkCenterCapabilityConnection!filter: WorkCenterCapabilityFilterInput
workCenterId: WorkCenterID!
All capability assignments for one work center in the caller's tenant, returned in a single unpaginated page. Requires workCenter:read permission.
listWorkCenterDevicesWorkCenterDeviceConnection!workCenterId: WorkCenterID!List the controller devices bound to a work center, preferred first. Requires workCenter:read.
listWorkCentersWorkCenterConnection!after: String
before: String
filter: WorkCenterFilterInput
first: Int
last: Int
sort: [WorkCenterSortInput!]
List the tenant's work centers as a paginated connection, with optional filtering and sorting. Requires workCenter:list permission.
listWorkCenterShiftProfilesWorkCenterShiftProfileConnection!filter: WorkCenterShiftProfileFilterInput
workCenterId: WorkCenterID!
Lists the shift profiles of one work center within the caller's tenant, ordered by validFrom ascending. Requires workCenter:read.
listWorkCenterStatusEventsWorkCenterStatusEventConnection!from: ISO8601
limit: Int
to: ISO8601
workCenterId: WorkCenterID!
List status transition events for a work center
listWorkflowsWorkflowConnection!after: String
before: String
filter: WorkflowFilterInput
first: Int
last: Int
sort: [WorkflowSortInput!]
List workflows with pagination. Requires workflow:list permission.
listWorkflowVersionsWorkflowVersionConnection!after: String
before: String
filter: WorkflowVersionFilterInput
first: Int
last: Int
sort: [WorkflowVersionSortInput!]
List workflow versions with pagination. Requires workflow:list permission.
listWorkspacesWorkspaceConnection!after: String
filter: WorkspaceFilterInput
first: Int
sort: [WorkspaceSortInput!]
List the caller's visible workspace library (own personal + their teams' + instance).
listWorkspaceVersionsWorkspaceVersionConnection!after: String
first: Int
workspaceId: WorkspaceID!
List all versions of a workspace, newest first (authoring history), if the caller may see it.
luaApiSurface[LuaApiEntry!]!role: LuaScriptRole!Structured ctx.* surface for editor completions and hover. Empty for EDGE_APP. Requires script:read.
luaTypeDefinitionsString!role: LuaScriptRole!Type definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.
magicQueryJSON!query: QueryScalar!Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
metricCorrelationMetricCorrelationResult!input: MetricCorrelationInput!Compute statistical correlation between two metrics over a time range. Returns Pearson correlation coefficient, slope, intercept, R-squared, and covariance. Metrics are joined by 1-second time buckets. Uses Toolkit stats_agg() 2D. Requires metric:read permission.
metricHeartbeatMetricHeartbeatResult!input: MetricHeartbeatInput!Analyze uptime and downtime for a heartbeat-style metric. Detects gaps where no value was received within the expected interval. Returns total uptime/downtime, uptime percentage, and individual gap periods. Uses Toolkit heartbeat_agg(). Requires metric:read permission.
metricHistogramMetricHistogramResult!input: MetricHistogramInput!Compute a value distribution histogram for a metric over a time range. Uses TimescaleDB's histogram() function. Range bounds are auto-detected if not specified. Requires metric:read permission.
metricPercentilesMetricPercentilesResult!input: MetricPercentilesInput!Compute percentile values (e.g. p50, p95, p99) for a metric over a time range. Supports both exact (percentile_cont) and approximate (UddSketch via Toolkit) modes. Approximate mode is faster for large datasets. Useful for SLA analysis and outlier detection. Requires metric:read permission.
metricProjectionMetricProjectionResult!input: MetricProjectionInput!Compute a linear regression over historical data and project forward. Returns slope, R-squared, projected values with confidence intervals, and optionally the estimated time a target value will be reached. Requires metric:read permission.
metricStateDurationMetricStateDurationResult!input: MetricStateDurationInput!Analyze time spent in each discrete state for a status metric. Returns both a duration breakdown by state and a chronological timeline of state transitions (Gantt-chart-ready). Requires a metric with kind STATUS. Uses Toolkit state_agg(). Requires metric:read permission.
myTasksTaskConnection!after: String
filter: TaskFilterInput
first: Int
sort: [TaskSortInput!]
List tasks assigned to the current user or their teams. Requires task:list permission.
orderLifecycleOrderLifecyclePayload!orderId: OrderID!Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.
pingString!Health check endpoint
preflightCheckPreflightCheckPayload!input: PreflightCheckInput!Run preflight on supplied PDF bytes inline (not persisted). Requires preflightReport:read permission.
previewDataClipReportQueryPayload!input: PreviewDataClipInput!Preview a MicroSQL query without saving (returns tabular results)
previewImpositionPreviewImpositionPayload!input: PreviewImpositionInput!Preview imposition layout without creating records. Used for estimation when no component exists yet.
producibilityIntelligenceProducibilityIntelligenceOutput!input: ProducibilityIntelligenceInput!Combined producibility intelligence: rule-based feasibility, ML predictions, risk analysis, and similar historical jobs in a single query. All ML fields degrade to null when no models are trained.
productionBoardProductionBoardPayload!fromDate: String
statuses: [JobStatus!]
toDate: String
Fetch active production jobs with components, operations, and order context. Requires job:list.
provenanceImpact[GraphNode!]!direction: String
entityId: ID!
maxDepth: Int
Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
provenanceTraceGraphTrace!direction: String
entityId: ID!
maxDepth: Int
Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
queryProgressPointsProgressPointConnection!after: String
filter: ProgressPointFilterInput
first: Int
Query progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.
quotingReadinessCheckQuotingReadinessPayload!Check whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.
renderArtworkPreviewRenderArtworkPreviewPayload!input: RenderArtworkPreviewInput!Render a page of an artwork file to a JPEG preview (base64). Requires componentArtworkFile:read permission.
renderPlateSeparationRenderArtworkPreviewPayload!input: RenderPlateSeparationInput!Render a single ink separation (plate) of an artwork page to a grayscale PNG (base64). Requires componentArtworkFile:read permission.
renderPreviewRenderArtworkPreviewPayload!input: RenderPreviewInput!Render a page of supplied PDF bytes to a JPEG preview (base64) inline. Requires componentArtworkFile:read permission.
renderSeparationRenderArtworkPreviewPayload!input: RenderSeparationInput!Render a single ink separation (plate) from supplied PDF bytes to a grayscale PNG (base64) inline. Requires componentArtworkFile:read permission.
reportQueryReportQueryPayload!query: String!Execute a MicroSQL reporting query against the analytics schema. Supports SELECT with WHERE, JOIN, ORDER BY, GROUP BY, LIMIT. Tenant isolation is enforced automatically. Covers production (jobs, components, operations, milestones), prepress, scheduling (work_centers, planned_operations, schedule_allocations), sales (estimates, orders, invoices), cost accounting, catalog/inventory (products, substrates, warehouse_stock), logistics (shipments), tasks, time-series (metric_points, progress_points), and people (users, teams). Per-table IAM authorization is enforced — requires :list on each table's resource.
retrieveKnowledgeKnowledgeRetrieval!limit: Int
query: String
seeds: [ID!]!
The retrieval (RAG) entry point. Given the entities in context (seeds) and an optional query, returns the most relevant knowledge in two buckets — graph-reached and semantically-supporting — each ranked by a blended relevance score. Requires knowledgeNote:read permission.
searchSchemaFields[SchemaDocSearchResult!]!query: String!
topK: Int
Semantic search over GraphQL fields on types
searchSchemaMutations[SchemaDocSearchResult!]!query: String!
topK: Int
Semantic search over GraphQL mutation operations
searchSchemaQueries[SchemaDocSearchResult!]!query: String!
topK: Int
Semantic search over GraphQL query operations
searchSchemaTypes[SchemaDocSearchResult!]!query: String!
topK: Int
Semantic search over GraphQL types (objects, inputs, enums)
sharedResourceInstallations[SharedResourceInstallationState!]!Every catalog template this tenant has installed, with the version installed — the basis for detecting available upgrades. Requires sharedResource:list permission.
sharedResourcesSharedResourceConnection!category: String
page: Int
perPage: Int
resourceType: SharedResourceType
search: String
Browse the shared-resource catalog served by the CoCoCo control plane, with optional type, text and category filters. Requires sharedResource:list permission.
storageCapabilitiesStorageCapabilitiesOutput!Which storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.
validateEdgeAppSourceValidateEdgeAppSourceResult!input: ValidateEdgeAppSourceInput!Type-check edgeApp handler / library / onMessage Lua sources against the bridge's ambient API typedef without persisting anything. Safe to call from editors on every keystroke. Requires edge_app:read permission.
verticalProductionUnits[VerticalUnitDescriptor!]!vertical: StringDiscover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.
whatIfWhatIfResult!direction: String
extraEdges: [WhatIfEdgeInput!]!
graph: String
maxDepth: Int
seeds: [ID!]!
First-class hypothetical impact: the delta between the baseline reachable set from seeds and the reachable set with extraEdges unioned in, plus whether the injected edges introduce a cycle. Requires provenance:read permission.
workCenterDeviceJMFDeviceIDStringworkCenterDeviceId: WorkCenterDeviceID!Read the JMF DeviceID set on a work center ↔ device binding. Requires workCenter:read.
workflowTriggerWorkflowTriggerStateid: WorkflowTriggerID!Get a workflow trigger by ID. Requires workflow:read permission.
workflowTriggers[WorkflowTriggerState!]!workflowId: WorkflowID!List all triggers for a workflow. Requires workflow:list permission.

Relationships ​

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