Query
Fields
Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
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.
Arguments (1)
The Magic Query string, e.g. 'jobs?limit=10,status=approved'.
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
Arguments (1)
A Magic Query string; only the noun is required, e.g. 'jobs'.
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
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.
Arguments (1)
A Magic Query string to resolve, e.g. 'jobs?limit=10'.
This instance's settings. Needs tenantPreferences:read or tenantConfig:read; each section then needs the permission that guarded its data before Settings existed, and is null with an error without it.
List all valid data change event topics, grouped by resource. Requires authentication.
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.
Read up to 100 comments and events, oldest first, with an exclusive cursor. Includes comment capability, never apply authority.
Arguments (3)
Owning stack.
Change Request whose timeline is read.
Exclusive entry ID from the previous page.
Read bounded plan highlights for at most 100 stack-local Change Requests.
Arguments (2)
Owning stack.
Change Request identities, at most 100.
Read a safe projection of the original stored plan. No private inputs, approvals or execution authority are returned.
Arguments (3)
Owning stack.
Change Request identity.
Return every planned action instead of the highlights.
Summarise a stack: revision, owner, last apply, resource kinds and pending changes. Requires stack read access.
Arguments (1)
Stack to summarise.
List deployed resources and those only open Change Requests would create, with the last and pending Change Requests for each. Requires stack read access.
List a stack's applied revisions, newest first, each linked to the Change Request that produced it. Requires stack read access.
Arguments (2)
Stack whose history is read.
Exclusive fromSerial of the last revision on the previous page.
Read README.md at the root of the stack's main branch as UTF-8 text; null without main or without a root README. Refused with README_TOO_LARGE above 256 KiB. Requires stack read access.
Arguments (1)
Stack whose notes are read.
Read what the viewer may do on a stack, and who may apply its changes.
Arguments (1)
Stack whose permissions are read.
Discover the authenticated Git remote for an authorized stack.
Arguments (1)
Owning stack.
Read a bounded source snapshot after tenant, IAM and stack-grant authorization.
Arguments (1)
Existing stack whose source is requested.
List up to 100 Change Requests, newest first, optionally filtered by branch, status or author. Requires stack read access.
Arguments (5)
Owning stack.
Exclusive last ID from the previous page.
Only Change Requests opened from this branch ref, e.g. refs/heads/feature.
Only Change Requests in this status: draft, applied or cancelled.
Read one draft Change Request in its owning stack.
Read immutable public GitHub package bytes for editor intelligence; validates lock integrity and creates no executable identity.
Arguments (2)
Stack whose read permission is checked.
Public bindings, original module lock metadata and revision; no IaC resource declarations or private inputs.
Non-executable advisory plan; persists no source, approval, lease or execution state.
Arguments (3)
Stack whose current state is inspected.
Complete ProjectInput JSON with dirty root files, target and private variables. Remote packages are server-owned.
Bypass immutable content caches for this plan and its apply recheck.
Read-only coordinator capability; ordinary clients cannot invoke it.
Arguments (1)
Stack id (stk_…).
Reconcile a lost Apply response. Only the planning principal may inspect the result.
Arguments (2)
Owning stack.
Server plan whose committed outcome is requested.
List stacks visible to this user, up to 100 per page.
Arguments (2)
Deployment environment assertion.
Last stack id from the previous page.
Read current deployment state; source is held separately in Git.
Arguments (1)
Stack id (stk_…).
List a stack's secrets by name with their version history, never their values. Requires stack read access.
Arguments (1)
Stack whose secrets are listed.
List the current value of every variable the stack holds, set ones only, with secrets listed by name and never by value. Requires stack read access.
Arguments (1)
Stack whose values are listed.
List the variables a commit's source declares, in declaration order, for checking that a stack holds a value for each before promoting that commit. Requires stack read access.
Arguments (2)
Stack whose repository holds the commit.
Commit to read; omitted reads main. Without main and without a commit the list is empty.
Read a stack's rules; a stack that never set any reads the defaults. Requires stack read access.
Arguments (1)
Stack whose rules are read.
Health check endpoint
Fetch a job by ID. Requires job:read permission.
Fetch a job by external ID. Requires job:read permission.
Arguments (1)
External system identifier
List jobs with pagination and filtering. Requires job:list permission.
Aggregate jobs with optional filtering. Returns count, sum, avg, min, max. Requires job:list permission.
Arguments (1)
Filter criteria (same filters as listJobs)
Resolve supplied assembly data and optionally return an SVG using generic hints and vertical heuristics. Requires job:read. No persistence.
Arguments (1)
Headless components and optional explicit graph; no persisted lookup or writes.
Read a tenant-scoped job assembly, report uncertainties and optionally generate its SVG. Requires job:read and component:read. Does not persist inference.
Fetch a job group by ID. Requires jobGroup:read permission.
Arguments (1)
Job group ID
List job groups with pagination. Requires jobGroup:list permission.
Fetch one batch; tenant scoped
List Batches with bounded pagination
Fetch one batchComponent; tenant scoped
Arguments (1)
Identifier to fetch
List BatchComponents with bounded pagination
Fetch one batchContribution; tenant scoped
Arguments (1)
Identifier to fetch
List BatchContributions with bounded pagination
Arguments (6)
Maximum page size
Continue after this cursor
Find work assigned to a batch
Find batches containing source job work
Filter by original component
Find work assigned to a form
Fetch a product template by ID. Requires productTemplate:read permission.
Arguments (1)
Product template ID
List product templates with optional filters, sorted by name. Requires productTemplate:list permission.
Arguments (6)
Filter by SKU (exact match)
Filter by active status
Filter by category (exact match)
Filter by status (DRAFT or PUBLISHED)
Number of items from the start
Cursor to start after
List published versions of a template with pagination. Requires productTemplate:read permission.
Arguments (3)
Product template ID
Number of items from the start
Cursor to start after
Fetch a specific published version. Requires productTemplate:read permission.
Arguments (2)
Product template ID
Version number
Fetch a milestone by ID. Requires milestone:read permission.
Arguments (1)
Milestone ID to fetch
Fetch a milestone by any of its external ids. Every supplied id must match; with none, returns null. Requires milestone:read permission.
Arguments (3)
External system identifier
External id of the record marking the start
External id of the record marking the completion
List milestones with pagination and filtering. Requires milestone:list permission.
Fetch a component by ID. Requires component:read permission.
Arguments (1)
Component ID to fetch
Fetch a component by external ID. Requires component:read permission.
Arguments (1)
External system identifier
List components with pagination and filtering. Requires component:list permission.
Aggregate components with optional filtering. Returns count, sum, avg, min, max. Requires component:list permission.
Arguments (1)
Filter criteria (same filters as listComponents)
Fetch a component section by ID. Requires componentGroup:read permission.
Arguments (1)
Component section ID to fetch
List component sections, optionally scoped to a job. Requires componentGroup:list permission.
Fetch an operation by ID. Requires operation:read permission.
Arguments (1)
Operation ID to fetch
Fetch an operation by external ID. Requires operation:read permission.
Arguments (1)
External system identifier
List operations with pagination and filtering. Requires operation:list permission.
Aggregate operations with optional filtering. Returns count, sum, avg, min, max. Requires operation:list permission.
Arguments (1)
Filter criteria (same filters as listOperations)
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.
Fetch a script by ID. Requires script:read permission.
Fetch a script by name. Requires script:read permission.
A script's history, newest first. Requires script:read permission.
Fetch one version of a script. Requires script:read permission.
List scripts with pagination and filtering. Requires script:list permission.
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.
Arguments (2)
Only samples for this scripting role (default: all)
Possible values (4)
NORMALEvery platform capability. Runs playground and stored scripts, workflow script nodes, custom workflow actions, incoming webhooks, custom app server functions, workspace handlers, portal handlers, MCP tools, archive jobs, quote price tuning, plugin seeds and integration extensions.
INTEGRATIONThe Normal functions except ctx.twin., with devices, templates and scripts reached only through the instance's bindings, cache, config, protobuf and store belonging to the instance, plus ctx.integration. metadata. Runs integration lifecycle hooks, integration handler scripts, integration server functions, integration workflow actions, integration API client setup and integration upgrade scripts.
PUREThe language only, with no ctx and no modules. Runs data pipeline stages, report preparation scripts, portal component exports, plugin middleware hooks, plugin event handlers, scheduler penalty functions, product template resolvers and JDF and JMF templates.
EDGE_APPEdge app bundle handlers on the bridge: the bridge.* global, SwiftLua-in-Go runtime, no ctx.
Only samples of this tier (default: all)
Possible values (2)
RECIPETask-shaped and multi-API — start here
SNIPPETOne host function, in isolation
Fetch one Lua sample with its runnable source. Requires script:read.
Type definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.
Arguments (1)
Which scripting surface to describe
Possible values (4)
NORMALEvery platform capability. Runs playground and stored scripts, workflow script nodes, custom workflow actions, incoming webhooks, custom app server functions, workspace handlers, portal handlers, MCP tools, archive jobs, quote price tuning, plugin seeds and integration extensions.
INTEGRATIONThe Normal functions except ctx.twin., with devices, templates and scripts reached only through the instance's bindings, cache, config, protobuf and store belonging to the instance, plus ctx.integration. metadata. Runs integration lifecycle hooks, integration handler scripts, integration server functions, integration workflow actions, integration API client setup and integration upgrade scripts.
PUREThe language only, with no ctx and no modules. Runs data pipeline stages, report preparation scripts, portal component exports, plugin middleware hooks, plugin event handlers, scheduler penalty functions, product template resolvers and JDF and JMF templates.
EDGE_APPEdge app bundle handlers on the bridge: the bridge.* global, SwiftLua-in-Go runtime, no ctx.
Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.
Arguments (1)
Which scripting surface to describe
Possible values (4)
NORMALEvery platform capability. Runs playground and stored scripts, workflow script nodes, custom workflow actions, incoming webhooks, custom app server functions, workspace handlers, portal handlers, MCP tools, archive jobs, quote price tuning, plugin seeds and integration extensions.
INTEGRATIONThe Normal functions except ctx.twin., with devices, templates and scripts reached only through the instance's bindings, cache, config, protobuf and store belonging to the instance, plus ctx.integration. metadata. Runs integration lifecycle hooks, integration handler scripts, integration server functions, integration workflow actions, integration API client setup and integration upgrade scripts.
PUREThe language only, with no ctx and no modules. Runs data pipeline stages, report preparation scripts, portal component exports, plugin middleware hooks, plugin event handlers, scheduler penalty functions, product template resolvers and JDF and JMF templates.
EDGE_APPEdge app bundle handlers on the bridge: the bridge.* global, SwiftLua-in-Go runtime, no ctx.
Read a BOT service account. Returns null for HUMAN and KIOSK accounts.
Read an existing user without claiming IaC ownership.
Look up an existing user by email or external identifier without claiming IaC ownership.
Arguments (2)
User email address
External system identifier
Fetch a user by ID. Requires user:read permission.
Fetch a user by external ID or email. Requires user:read permission.
Arguments (2)
External system identifier
User email address
List users with pagination and filtering. Requires user:list permission.
Conditional authoring availability and supported actions, business attributes, operators and limits. Metadata only; does not grant access.
Simulate a draft alongside a user's attached policies, or replacing one attachment. Requires iam:listUserPolicies and iam:readPolicy. Supplied time, network and sample values are simulation only; no resource records are read or permissions changed.
Arguments (1)
User, draft document and simulated conditions
Read a conditional policy attachment in the current tenant.
Arguments (1)
Policy attachment identifier
Read a policy attachment in the current tenant.
Arguments (1)
Policy attachment identifier
List all available IAM actions grouped by resource. Requires authentication.
Who the caller is and which tenant they are acting in. Requires authentication but no permission: a caller asking who they are needs no authority over anything.
Get current user's effective permissions. Requires authentication.
Fetch an IAM policy with its revision. Requires iam:readPolicy permission.
Arguments (1)
Policy ID to fetch
Fetch an IAM policy by ID. Requires iam:readPolicy permission.
Arguments (1)
Policy ID to fetch
List IAM policies with pagination. Requires iam:listPolicies permission.
List policies attached to a user. Requires iam:listUserPolicies permission.
Compile XML and analyze shared workflow contracts without executing operations; JSON analysis result
Fetch a single workflow by ID. Requires workflow:read permission.
Arguments (1)
Workflow ID to fetch
List workflows with pagination. Requires workflow:list permission.
Read authoritative workflow XML for IaC, including canonical exports of legacy versions
Arguments (1)
Workflow version whose original source or canonical XML export should be returned
Fetch a single workflow version by ID. Requires workflow:read permission.
Arguments (1)
Version ID to fetch
List workflow versions with pagination. Requires workflow:list permission.
Get the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.
Compile Journey XML without saving or executing steps.
Fetch a single journey by ID, if the caller may see it.
Fetch a journey by its stable handle (deep links / anchored launches), if the caller may see it.
List the caller's visible journey library (own personal + their teams' + instance).
Arguments (4)
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
Cursor from a previous page's endCursor — the page starts at the journey after it. An unresolvable cursor is ignored and the first page is returned.
Optional handle / status filter, narrowing the journeys the caller may already see. It can never widen visibility.
Ordering clauses; only the first is applied. Defaults to UPDATED_AT descending.
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.
Arguments (1)
TypeID of the journey version to fetch (prefix jnv).
List all versions of a journey, newest first (authoring history), if the caller may see it.
Arguments (3)
TypeID of the journey whose version history to list (prefix jny). Returns an empty page when the journey is unknown or not visible to the caller.
Page size. Omitted returns up to the default page size.
Cursor from a previous page's endCursor — the page starts at the version after it. An unresolvable cursor is ignored and the first page is returned.
Analyze Workspace XML and Lua without saving, executing handlers or querying business data. Requires Workspace authoring permission.
Fetch a single workspace by ID, if the caller may see it.
Arguments (1)
TypeID of the workspace to fetch (prefix wks). Returns null when it does not exist or the caller may not see it.
Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.
List the caller's visible workspace library (own personal + their teams' + instance).
Arguments (4)
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
Cursor from a previous page's endCursor; results resume after it. An unresolvable cursor is ignored and the first page is returned.
Optional criteria (handle, computed status) narrowing the visible workspaces.
Ordering terms; only the first is applied. Defaults to UPDATED_AT / DESC.
Author-only XML/Lua source envelope for one Workspace version. Compiler artifacts remain internal.
Arguments (1)
Workspace version to inspect or invoke.
Runs a declared read-only Lua loader on the current published Workspace version; returns JSON.
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.
Arguments (1)
TypeID of the workspace version to fetch (prefix wsv).
List all versions of a workspace, newest first (authoring history), if the caller may see it.
Arguments (3)
TypeID of the workspace whose versions to list (prefix wks). Returns an empty page when unknown or not visible to the caller.
Page size. Omitted returns up to the default page size.
Cursor from a previous page's endCursor; results resume after it. An unresolvable cursor is ignored and the first page is returned.
Read, compile and type-check a Portal site document without saving it. Returns valid; diagnostics (each with the model path, message, severity error or warning, and the original sourceRange); projection, the document in its model shape; pages, keyed by page pointer (/pages/0), with each page's server Lua exports in source order, so an editor can offer a handler for an export that has none; components, each site component's security and events with their inferred input and output schemas; and locations, source ranges by model pointer.
Read a .portal page or component file into the model's shape without saving anything. Returns valid; identified, true when the file names its part (<page route>, <component name>) and false for bare blocks, whose route or name the caller supplies; part, the portal_page or portal_component model object, or null when the file cannot be read; and diagnostics, each with its model path, message, severity and sourceRange in the file.
Arguments (2)
Whether the file holds a page or a component.
Possible values (2)
PAGEA page: <page route> or its blocks (template, server, handlers, style).
COMPONENTA component: <component name> or its blocks (props, template, style, server).
The .portal file's text: the part's element, or its bare blocks.
The bundled component library: its version and every component with its .portal text and model object.
Read one Portal in this tenant, or null when it does not exist.
List this tenant's Portals in creation order.
List the custom domain aliases reserved for a Portal, with their last known status.
Read one Portal site, or null when it does not exist.
Arguments (1)
Site to read.
List the sites of a Portal in creation order.
Read one immutable site source snapshot, or null when it does not exist.
Arguments (1)
Snapshot to read.
Read a site version's source as typed parts (pages, components, routes, tools, libraries, layouts, styles, assets) with the canonical source, or null when the version does not exist. A sibling of getPortalSiteVersion, so the parts never enter IaC state. Fails closed when the stored source no longer passes the current reading rules (it was saved under rules that have since changed): the error carries extensions.code PORTAL_SITE_SOURCE_UNREADABLE, and the snapshot itself is still readable with getPortalSiteVersion.
Arguments (1)
Site version whose source to read.
List the source snapshots of a site in creation order.
Render one page of a site snapshot to HTML for authoring preview. Business-data access is denied while previewing.
Arguments (2)
Snapshot to render; it need not be published.
Request path of the page to render, such as /.
Read one PortalUser, or null when it does not exist.
Arguments (1)
PortalUser to read.
List this tenant's PortalUsers in stable identifier order.
Read one Portal membership, or null when it does not exist.
Arguments (1)
Membership to read.
List the memberships of a Portal in stable identifier order.
Read one Portal API credential's metadata, or null when it does not exist. The secret is never returned.
Arguments (1)
Credential to read.
List the API credentials issued for a Portal in stable identifier order, without their secrets.
Read one Portal login ticket's metadata, or null when it does not exist. The secret is never returned.
Arguments (1)
Ticket to read.
List the login tickets issued for a Portal in stable identifier order, without their secrets.
Read the authoring definition and assignments.
The caller's tool catalog: enabled, published tools assigned to them directly or through a team. Any signed-in user; assignment is the grant.
The caller's own finished tool invocations, newest first. Nobody else's are ever listed; still-running ones are left out.
List tenant tools for administration; not the end-user catalog.
Read immutable publication history.
Infer and decorate a tool contract without saving or running it.
Arguments (3)
Lua source; never executed by analysis.
Input metadata overlay.
Output metadata overlay.
Fetch one integration. Requires integration:read permission.
Arguments (1)
TypeID of the integration (prefix igr)
List integrations, one row each. Drill into versions with listIntegrationDefinitions. Requires integration:list permission.
Get a workflow trigger by ID. Requires workflow:read permission.
Arguments (1)
TypeID (prefix wft) of the trigger to fetch. Returns null if no such trigger exists.
List all triggers for a workflow. Requires workflow:list permission.
Arguments (1)
TypeID (prefix wfl) of the workflow whose triggers are listed. Results are scoped to the caller's tenant; enabled and disabled triggers are both returned.
List all triggers for the current tenant. Requires workflow:list permission.
Fetch a single workflow execution by ID. Requires workflow:read permission.
Arguments (1)
Execution ID to fetch
List workflow executions with pagination. Requires workflow:list permission.
Fetch all steps for a workflow execution. Requires workflow:read permission.
Arguments (1)
Execution ID to fetch steps for
Inspect the exact workflow runner authority and audited recovery revision. Requires workflow:read permission.
Arguments (1)
Execution ID to inspect
Aggregate a workflow's runs over a time window: totals by status, duration percentiles, time buckets and per-node outcomes. Requires workflow:list permission.
Arguments (4)
Workflow whose runs are aggregated
Start of the window (inclusive), by run start time
End of the window (exclusive); defaults to now
Bucket size in minutes, clamped to 5–1440. A window needing more than 500 buckets is rejected.
Default: 60
Run health of every workflow in the tenant that has a run since since or a run currently waiting: failures in the window, waiting runs and the latest run's status. Requires workflow:list permission.
Fetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.
Arguments (2)
Card ID to fetch
Optional: the dashboard the card is on. A card ID is unique, so this is only a check; a card on another dashboard is not found.
Fetch a dashboard by ID with its cards. Requires dashboard:read permission.
Arguments (1)
Dashboard ID to fetch
List dashboards visible to the current user. Returns personal dashboards owned by the user and shared dashboards. Requires dashboard:list permission.
Fetch a custom app by ID. Requires customapp:read permission.
Arguments (1)
Custom app ID to fetch
Fetch a custom app by handle. Requires customapp:read permission.
List custom apps with pagination and filtering. Requires customapp:list permission.
List custom app user bindings. Requires customappuser:read permission.
List custom app team bindings. Requires customappteam:read permission.
Fetch a custom app version by ID. Requires customapp:read permission.
Arguments (1)
Version ID to fetch
List versions for a custom app. Requires customapp:read permission.
Arguments (5)
Custom app to list versions for
Number of items from the start
Cursor to start after
Filter criteria
Sort order
The published journeys the caller may run or list, for menus and runners. Visible items are those the caller may read as a resource, plus their own PERSONAL items with no permission grant. The caller's own PERSONAL journeys are listed even when their required domains are out of reach, with access.usable false and no definition.
One published journey by handle, as journeyViews would list it; null when unknown, unpublished or not visible to the caller.
Arguments (2)
The journey's stable handle.
TypeID of a published version of this journey to serve instead of the current one (prefix jnv), so a run resumes on the version it started. Null is returned when it is a draft or belongs to another journey.
The published workspaces the caller may open or list, for menus and renderers. Visible items are those the caller may read as a resource, plus their own PERSONAL items with no permission grant. The caller's own PERSONAL workspaces are listed even when their required domains are out of reach, with access.usable false and no definition.
One published workspace by handle, as workspaceViews would list it; null when unknown, unpublished or not visible to the caller.
The published custom apps the caller may run. With customapp:list, every app visible to them; without it, the apps assigned to them directly or through one of their teams.
One published custom app by handle, as customAppViews would list it (customapp:read in place of customapp:list); null when unknown, unpublished or not visible to the caller.
Fetch a custom data container by ID. Requires customapp:read permission.
Arguments (1)
Container query input
List containers for a custom app with pagination. Requires customapp:read permission.
List containers tagged to a specific entity with pagination. Requires customapp:read permission.
Fetch a data schema by ID. Requires dataschema:read permission.
Arguments (1)
Schema query input
Fetch a data schema by name. Requires dataschema:read permission.
Arguments (1)
Schema query input by name
List all data schemas for the current tenant with pagination. Requires dataschema:read permission.
List data schemas with pagination. Requires dataschema:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a data record by ID. Requires datarecord:read permission.
Arguments (1)
Record query input
List data records for a schema with pagination. Requires datarecord:read permission.
List data records with pagination. Requires datarecord:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria (schemaId required)
Sort order
List data records tagged to a specific entity with pagination. Requires datarecord:read permission.
Fetch a protobuf schema by ID. Requires protobufSchema:read permission.
Arguments (1)
Schema query input
Fetch a protobuf schema by name. Requires protobufSchema:read permission.
Arguments (1)
Schema query input by name
List protobuf schemas with pagination. Requires protobufSchema:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single network by ID. Requires network:read permission.
List networks with pagination. Requires network:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for networks
Sort order for results
Fetch a single controller by ID. Requires controller:read permission.
Arguments (1)
Controller ID to fetch
Check whether a controller has an active bridge connection. Requires controller:read permission.
Possible values (2)
CONNECTEDConnected via bridge transport
DISCONNECTEDNot connected
Arguments (1)
Controller ID to check connection status for
Latest discovery and health snapshot, with platform receipt time and freshness
Arguments (1)
Controller ID
List controllers with pagination. Requires controller:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for controllers
Sort order for results
List controller tokens with pagination. Requires controller_token:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for controller tokens
Sort order for results
Validate complete EdgeApp XML without saving; returns compiler catalog and original source ranges.
Fetch a edge app by ID. Requires edge_app:read permission.
List edge apps with pagination. Requires edge_app:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria
Sort order for results
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.
Arguments (1)
EdgeApp scripts to type-check
Read exact EdgeApp XML for authoring. Requires edge_app:write permission.
Fetch a edge app installation by ID. Requires edge_app_installation:read permission.
Arguments (1)
EdgeApp installation ID
List edge app installations with pagination. Requires edge_app_installation:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria
Sort order for results
Fetch a edge app event by ID. Requires edge_app_event:read permission.
Arguments (1)
Edge app event ID
List edge app events with pagination. Requires edge_app_event:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria
Sort order for results
Fetch a controller policy by its ID. Requires controller_policy:read permission.
Arguments (1)
Controller policy ID
Fetch a controller's policy by the controller ID (the natural key). Returns null if no policy is configured (default-deny).
Arguments (1)
Controller to look up
List controller policies with pagination. Requires controller_policy:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria
Sort order for results
Fetch a single device by ID. Requires device:read permission.
List devices with pagination. Requires device:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for devices
Sort order for results
List device tokens with pagination. Requires device_token:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for device tokens
Sort order for results
Fetch an API token by ID (user can only see their own tokens). Requires apitoken:read permission.
Arguments (1)
API token ID to fetch
List the current user's API tokens with pagination. Requires apitoken:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
List the API tokens belonging to a bot user. Returns an empty list if the target user is not a bot. Requires apitoken:list permission.
Arguments (5)
Bot user whose tokens to list
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch an AI adapter by ID. Requires aiadapter:read permission.
Arguments (1)
AI adapter ID to fetch
List AI adapters with pagination and filtering. Requires aiadapter:list permission.
Fetch an AI agent by ID. Requires aiAgent:read permission.
List AI agents with pagination. Requires aiAgent:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Check ml-model XML without saving it: returns { valid, diagnostics: [{ path, message, severity, sourceRange }], elements }, where elements is the compiler's vocabulary for editor completion. Requires mlmodelconfig:read permission.
Fetch an ML model config by ID. Requires mlmodelconfig:read permission.
Arguments (1)
ML model config ID to fetch
List ML model configs with pagination and filtering. Requires mlmodelconfig:list permission.
Export an ML model config as JSON or YAML. Requires mlmodelconfig:read permission.
Arguments (1)
Export input (ID and format)
List versions for an ML model config, newest first, with pagination. Requires mlmodelconfig:read permission.
Get the most recently trained version of an ML model config, published or not, with its holdout evaluation; null before the first successful training run. Requires mlmodelconfig:read permission.
Arguments (1)
ML model config ID to get the latest version of
Get a specific ML model config version by ID. Requires mlmodelconfig:read permission.
Arguments (1)
Version ID to fetch
Your ML experiments, most recently active first, ordered as stored when each page is read: an experiment opened while you page moves to the front and may be skipped or repeated. Requires mlmodelconfig:execute permission and a signed-in user.
Open one of your ML experiments, which marks it active; null when you have no such experiment. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (1)
ID of one of your experiments
Fetch one of your chat sessions by ID. Your own OPS sessions need only a login; any other session requires chatsession:read permission.
Arguments (1)
Chat session ID to fetch
List your chat sessions with pagination and filtering. Listing only OPS sessions (filter context eq OPS) needs only a login; any other listing requires chatsession:list permission.
Report configured adapter eligibility for this tenant. This is not a live provider health check; use testAIAdapter to verify credentials and model access. ops needs only a login; the adapter ids require chatsession:read permission and are null without it.
Complete bounded lifecycle/deletion feed. A reset cursor is captured before full reconciliation; persist only with corresponding observations.
Observe live lifecycle and revision without loading definition content. Requires integrationDefinition:read permission.
Arguments (1)
Integration definition ID to observe
Fetch a single integration definition by ID. Requires integrationDefinition:read permission.
Arguments (1)
Integration definition ID to fetch
List integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.
Arguments (6)
Number of items from the start
Number of items from the end
Cursor to start after
Cursor to start before
Sort order
Filter criteria
Compiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only.
Inspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence. Works after desired configuration deletion.
Arguments (1)
Integration installation whose retired sessions to list, including a deleted one.
Read exact runtime identities and management revision before an operator recovery action.
Arguments (1)
Integration installation to inspect.
Fetch a single integration instance by ID. Requires integrationInstance:read permission.
Arguments (1)
Integration instance ID to fetch
List the timers declared in the native v3 definition backing this instance. Requires integrationInstance:read permission.
Arguments (1)
Integration instance ID whose declared timers should be listed
List integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.
Arguments (6)
Number of items from the start
Number of items from the end
Cursor to start after
Cursor to start before
Sort order
Filter criteria
Fetch an integration data container by ID. Requires integrationDataContainer:read permission.
Arguments (1)
Container query input
Fetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.
Arguments (1)
Container lookup input
List containers for an integration instance with pagination. Requires integrationDataContainer:list permission.
List containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.
Fetch a single custom action by id within the caller's tenant. Returns null when no such action exists. Requires customWorkflowAction:read permission.
Arguments (1)
TypeID (prefix cac) of the custom action to fetch.
List the caller's tenant's custom actions, filtered and sorted. Requires customWorkflowAction:list permission.
Arguments (4)
Forward page size: maximum number of actions to return after the after cursor. Defaults to 25 and may not exceed 100.
Cursor to page after, as returned in pageInfo.endCursor. Only actions positioned after it in the requested sort order are returned.
Restrict the listing by name, label, or active state. Omit to list all.
Ordering clauses; only the first clause is applied, and both its field and direction are honoured. Defaults to createdAt descending.
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.
Fetch a notification group by ID. Requires notificationGroup:read permission.
Arguments (1)
Notification group ID to fetch
List notification groups with pagination. Requires notificationGroup:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a notification recipient by ID. Requires notificationRecipient:read permission.
Arguments (1)
Notification recipient ID to fetch
List notification recipients with pagination. Requires notificationRecipient:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch an incoming webhook by ID. Requires incomingWebhook:read permission.
Arguments (1)
Webhook ID to fetch
List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.
List endpoint logs with pagination. Requires incomingWebhook:read permission.
Get aggregate statistics for an incoming webhook endpoint. Requires incomingWebhook:read permission.
Arguments (1)
Webhook endpoint ID to get stats for
List execution log entries for a given context, newest first
Arguments (5)
Type of execution context
Possible values (2)
INTEGRATION_INSTANCELog from an integration instance execution
WORKFLOW_EXECUTIONLog from a workflow execution
ID of the execution context (e.g., integration instance ID)
Filter by log level
Possible values (3)
INFOInformational message
WARNINGWarning message
ERRORError message
Number of items from the start
Cursor to start after
Query logs across all drains (webhook, execution, edge app, archive). Requires log:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria
Sort order for results
Fetch a single metric by ID. Requires metric:read permission.
List metrics with pagination. Requires metric:list permission.
Arguments (6)
Number of items to return from the start
Number of items to return from the end
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for metrics
Sort order for results
Query time-series data points for a metric. Returns a flat array ordered by timestamp, with summary stats. Requires metric:read permission.
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.
Arguments (1)
Aggregation parameters
Compute a value distribution histogram for a metric over a time range. Range bounds are auto-detected if not specified. Requires metric:read permission.
Arguments (1)
Histogram parameters
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.
Arguments (1)
Percentile parameters
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.
Arguments (1)
Projection parameters
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.
Arguments (1)
Comparison parameters
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.
Arguments (1)
State duration parameters
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.
Arguments (1)
Heartbeat parameters
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.
Arguments (1)
Downsample parameters
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.
Arguments (1)
Correlation parameters
Query progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.
Arguments (3)
Filter criteria
Forward page size: maximum number of points to return after the after cursor. Defaults to 25 and may not exceed 100.
Cursor to page after, as returned in pageInfo.endCursor. Points are ordered newest first, so this returns points strictly older than the cursor. Because the underlying time-series table has no per-row id, points sharing the exact same timestamp may straddle a page boundary.
Get the most recent progress snapshot for an operation. Requires progressPoint:read permission.
Arguments (1)
Operation ID to get the latest progress for
List status transition events for a work center
Arguments (5)
TypeID (wcr_ prefix) of the work centre whose history to read (required). Results are additionally scoped to the caller's tenant.
Inclusive lower bound on the event timestamp (ISO8601). Omit for no lower bound.
Inclusive upper bound on the event timestamp (ISO8601). Omit for no upper bound.
Include voided and superseded originals for audit history (default true). False excludes them before limiting; use to for a current-time cutoff.
Maximum number of events to return, newest first. Defaults to 50 and is capped at 200.
Fetch an operation completion record by ID. Requires operation:read permission.
Arguments (1)
Operation completion ID to fetch
Fetch the most recent completion record for an operation. Requires operation:read permission.
Arguments (1)
Operation ID to find completion for
List operation completion records with pagination. Requires operation:list permission.
Arguments (6)
Number of items from the start
Number of items from the end
Cursor to start after
Cursor to start before
Filter criteria
Sort order
Fetch a production report by ID. Requires productionReport:read.
Arguments (1)
TypeID of the report to fetch (prr_…). Resolves to null when no report with that id exists in the caller's tenant.
List production reports for the tenant, paginated. Requires productionReport:list.
Arguments (4)
Narrows the result set by binding refs, source integration, capability, or unbound-only. Omit to list every report in the tenant.
Orders the result set by the chosen timestamp and direction. Omit to order by creation time, newest first.
Maximum number of reports to return. Defaults to 25 and is clamped to a hard cap of 100.
Cursor to start after
Derive accepted output quantities after corrections without inventory reads. Use these quantities instead of summing unadjusted receipts.
Arguments (1)
Original accepted report whose corrections and effective output quantities to return.
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
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.
List human-facing manual chapters from the running deployment.
Read a chapter of the current published manual edition.
Search human-facing manuals using shared semantic and text retrieval.
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
Arguments (1)
JSON Schema to convert to native XML; at most 256 KiB.
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
Read a team membership by its own identity. Requires team:read permission.
Arguments (1)
Membership identity
Find a team by its unique name in the authenticated tenant. Requires team:read permission.
Fetch a team by ID. Requires team:read permission.
List teams with pagination. Requires team:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Teams an account belongs to. Requires team:read permission.
Fetch members of a team. Requires team:read permission.
Fetch a task definition by ID. Requires taskDefinition:read permission.
Arguments (1)
Task definition ID to fetch
List task definitions with pagination. Requires taskDefinition:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a task by ID. Requires task:read permission, except for one's own task (assigned to or claimed by the caller, or unclaimed on one of their teams), which any signed-in user can read.
List all tasks with pagination. Requires task:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
List the caller's own tasks: assigned to or claimed by them, or unclaimed on one of their teams. Any signed-in user; no permission needed.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria; bucket narrows to MINE or TEAM
Sort order
Count the caller's open tasks by bucket, overdue and personal. Any signed-in user; no permission needed.
Fetch the audit trail for a task, paginated. Requires task:read permission.
The caller's running timer, on any task, or null. Any signed-in user; no permission needed: the timer is their own.
The caller's own time entries on any task, newest first, voided ones included. Readable even once the task is no longer theirs to read. Any signed-in user; no permission needed: the entries are their own.
Fetch a single capability by id, scoped to the caller's tenant. Null when no visible capability has that id. Requires capability:read permission.
Arguments (1)
TypeID (prefix "cpb") of the capability to fetch.
Read an existing capability reference by identity. Returns null if not visible. Requires capability:read.
Arguments (1)
Identity of a capability visible to the caller.
Resolve an existing capability by code. A tenant-owned definition takes precedence over a shared definition, matching inference. Ambiguous definitions fail; missing codes return null. Read-only; requires capability:read.
List the capabilities visible to the caller's tenant — the tenant's own capabilities plus any non-tenant-scoped ones. Requires capability:list permission.
Arguments (6)
Forward page size: maximum edges to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
Backward page size: maximum edges to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
Opaque cursor from a previous edge; pages forward from just after it in the requested sort order. Cannot be combined with before.
Opaque cursor from a previous edge; pages backward from just before it in the requested sort order. Cannot be combined with after.
Predicates narrowing the result set. Omit to list every visible capability.
Ordering terms. Only the first term is applied, and both its field and direction are honoured. Defaults to createdAt descending.
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.
Arguments (1)
TypeID (prefix "shd") of the shift definition to fetch.
List the current tenant's shift definitions as a connection. Requires shiftDefinition:list permission.
Arguments (6)
Forward pagination: how many shift definitions to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
Backward pagination: how many shift definitions to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
Forward pagination: return only definitions following this edge cursor in the requested sort order. Cannot be combined with before.
Backward pagination: return only definitions preceding this edge cursor in the requested sort order. Cannot be combined with after.
Narrow the result by name and/or creation time. Omit to list every definition in the tenant.
Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to createdAt descending (newest first) when omitted.
Fetch a single work center by id, scoped to the caller's tenant. Null when no such work center exists. Requires workCenter:read permission.
Arguments (1)
TypeID (prefix "wcr") of the work center to fetch.
Fetch a work center by external ID. Requires workCenter:read permission.
Arguments (1)
External system identifier
List the tenant's work centers as a paginated connection, with optional filtering and sorting. Requires workCenter:list permission.
Arguments (6)
Return the first N work centers after the cursor (forward pagination).
Return the last N work centers before the cursor (backward pagination).
Opaque cursor from a previous page's edge; results start after it.
Opaque cursor from a previous page's edge; results end before it.
Criteria narrowing which work centers are returned; omit for all of them.
Ordering terms. The first term's direction drives keyset pagination (defaults to newest-created first); any further terms are secondary sorts.
Read production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.
Status history, published plan and shifts for up to 100 active work centers of one cell over a window of at most 36 hours. Schedule and shift permissions are checked independently.
Arguments (3)
Cell to read; null for work centers not assigned to a cell
Window start
Window end; at most 36 hours after from
One capability assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
Arguments (1)
TypeID of the capability assignment to fetch (prefix "wcc").
All capability assignments for one work center in the caller's tenant, returned in a single unpaginated page. Requires workCenter:read permission.
Arguments (2)
TypeID of the work center whose capabilities to list (prefix "wcr"). Required.
Optional narrowing of the work center's assignments by capability id.
One device binding by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
Arguments (1)
TypeID of the device binding to fetch (prefix "wcd").
List the controller devices bound to a work center, preferred first. Requires workCenter:read.
Arguments (1)
Work center whose device bindings to list (ordered by priority)
One shift profile assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
Arguments (1)
TypeID of the shift profile assignment to fetch (prefix "wsp").
Lists the shift profiles of one work center within the caller's tenant, ordered by validFrom ascending. Requires workCenter:read.
Arguments (2)
TypeID of the work center whose shift profiles to list (prefix "wcr"). Required — the query is always scoped to a single work center.
Optional additional filtering of the work center's shift profiles.
Fetch a single schedule scenario by id, or null when it does not exist. Requires scheduleScenario:read permission.
Arguments (1)
TypeID of the schedule scenario to fetch (prefix "sch").
List the caller's tenant's schedule scenarios as a keyset-paginated connection. Requires scheduleScenario:list permission.
Arguments (6)
Number of scenarios to take from the start of the page window (forward pagination).
Number of scenarios to take from the end of the page window (backward pagination).
Opaque cursor from a previous page; returns scenarios positioned after it.
Opaque cursor from a previous page; returns scenarios positioned before it.
Criteria narrowing which scenarios are returned. Omit to list all in the tenant.
Ordering terms. The first term's direction drives the createdAt keyset walk (DESC when omitted); further terms are applied as tie-breakers.
List the allocations of one schedule scenario, ordered by start time by default. Requires scheduleScenario:read permission.
Arguments (7)
TypeID of the schedule scenario to list allocations from ("sch_01K…"). Required — allocations are never listed across scenarios.
Optional filters narrowing the allocations within the scenario.
Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to startAt descending.
Forward pagination page size: how many allocations to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
Backward pagination page size: how many allocations to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
Cursor to page forward from: only allocations following it in the requested sort order are returned. Cannot be combined with before.
Cursor to page backward from: only allocations preceding it in the requested sort order are returned. Cannot be combined with after.
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.
Arguments (4)
Owning manufacturing form; select exactly one jobId or batchComponentId. Scope follows the successor.
TypeID (prefix job) of the job whose dependency edges to return.
Number of items from the start
Cursor to start after
List operation items for an operation, sorted by sortOrder, with pagination. Requires operation:read permission.
Arguments (3)
TypeID (opr_…) of the operation whose items to list. Results are scoped to the calling tenant; an unknown id yields an empty list.
Number of items from the start
Cursor to start after
List item-level dependency edges, with pagination. Filter by job and optionally by source/target operation. Requires operation:read permission.
Arguments (6)
Owning manufacturing form; select exactly one jobId or batchComponentId. Scope follows the successor.
TypeID of the job ("job_01K…") whose item edges to list. Alternatively select batchComponentId — edges are listed within one production scope.
Optional operation TypeID ("opr_01K…"); when given, only edges whose predecessor item belongs to that operation are returned.
Optional operation TypeID ("opr_01K…"); when given, only edges whose successor item belongs to that operation are returned. Combine with sourceOperationId to fetch the edges of a single operation pair.
Number of items from the start
Cursor to start after
Production plans of a job, newest version first, paginated. Plan headers only — no planned operations or edges. Requires productionPlan:read permission.
Arguments (4)
Form whose plans to list; exclusive with jobId.
TypeID of the job (job_…) whose plans to list.
Number of items from the start
Cursor to start after
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.
Arguments (1)
TypeID of the production plan (ppl_…) to fetch.
Get an optimization run by ID. Requires optimizationRun:read permission.
Arguments (1)
ID of the optimization run to retrieve
List optimization runs for a scenario, paginated. Requires optimizationRun:list permission.
Arguments (3)
Filter by schedule scenario
Number of items from the start
Cursor to start after
The latest behaviour profile version of a work centre, or null when none has been built. Requires workCenterBehaviorProfile:read permission.
Arguments (1)
The work centre whose latest profile version to return
Behaviour profile versions, paginated. Requires workCenterBehaviorProfile:list permission.
Arguments (6)
Optional filters
Sort order; defaults to newest computed first
Number of items from the start
Cursor to start after
Number of items from the end
Cursor to end before
The behaviour attributes the active vertical declares, highest priority first, so a custom app can render hypothetical inputs from the schema. Requires workCenterBehaviorProfile:read permission.
A simulation run by id, or null when none exists. Requires scenarioSimulationRun:read permission.
Arguments (1)
The run to fetch
Simulation runs, paginated. Requires scenarioSimulationRun:list permission.
Arguments (6)
Optional filters
Sort order; defaults to newest created first
Number of items from the start
Cursor to start after
Number of items from the end
Cursor to end before
Synchronous what-if over hypothetical work, optionally overlaid on a base scenario's allocations. Persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
Arguments (1)
Hypothetical work, optional base scenario and sampling options
The live shadow of one work centre, computed now. Requires workCenterBehaviorProfile:read permission.
Arguments (1)
The work centre to shadow
Work centres with a live shadow, newest transition first, each entry judged now; the filter applies to the state recorded by the latest transition, so an entry's live state may already differ. Catch-up confidences are the figures recorded at the latest transition (null once the judgement has moved on) — a page never replays the queue; workCenterTwinShadow recomputes them. Requires workCenterBehaviorProfile:read permission.
A work centre's twin transitions, newest first, of both tracks unless track narrows them. Requires workCenterBehaviorProfile:read permission.
Arguments (6)
The work centre whose transitions to list
Only transitions of this track; omit for both
Possible values (2)
SHADOWThe live shadow: what runs on the machine now, judged against its profile
PACEThe pace track: whether the machine's forecast pace has drifted from its own history, judged after each profile refresh
Number of items from the start
Cursor to start after
Number of items from the end
Cursor to end before
Project one work centre over the next N hours: per-shift bands of expected busy and lost minutes, a down-probability strip and per-allocation ends, from the machine's behaviour profile and its published plan. Synchronous; persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES, 336 hours and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
Arguments (1)
The work centre, the window and sampling options
Fetch a template by ID. Requires template:read permission.
Arguments (1)
Template ID to fetch
Fetch a template by handle. Requires template:read permission.
List templates with pagination and filtering. Requires template:list permission.
Fetch one template version by ID. Requires template:read permission.
Arguments (1)
Template version ID to fetch
List versions of a template with pagination. Requires template:read permission.
Arguments (3)
Template ID to list versions for
Number of items from the start
Cursor to start after
Fetch a file by ID. Requires file:read permission.
List files with pagination and filtering. Requires file:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.
Arguments (1)
TypeID ("wlc") of the warehouse location to fetch.
List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
Arguments (4)
Maximum number of locations to return from the start of the page. Defaults to 20; values above the server's page-size limit (100) are rejected.
Opaque cursor from a previous page's endCursor: the page starts at the location immediately after it, in the requested sort order.
Narrows the locations returned; omit to list all of the tenant's locations.
Ordering rules to apply. Only the first rule is honoured, and both its field and direction are applied; omit to order by creation time, newest first.
Fetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.
Arguments (1)
WarehouseStock TypeID (wst_…) of the record to fetch.
List the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.
Arguments (4)
Maximum number of records to return in this page. Defaults to 20; values above the server's page-size limit (100) are rejected.
Cursor of the last edge of the previous page (an edge cursor); the page starts at the record immediately after it, in the requested sort order.
Criteria narrowing which stock records are listed. Omit to list all records in the tenant.
Ordering instructions; only the first entry is applied, and both its field and direction are honoured. Omit to order by creation time, newest first.
Read an input allocation in the current tenant; requires warehouse stock read permission
Arguments (1)
Allocation identifier within the current tenant
Read a durable operation output in the current tenant; requires operation read permission
Arguments (1)
Output identity within the current tenant
Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.
Arguments (1)
TypeID of the transfer to fetch (prefix "wtr").
List the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.
Arguments (4)
Maximum number of transfers to return. Defaults to 20; values above the server's page-size limit (100) are rejected.
Cursor from a previous page's endCursor: the page starts at the transfer immediately after it, in the requested sort order.
Criteria narrowing which transfers are returned; unfiltered when omitted.
Sort order; only the first entry is applied, and both its field and direction are honoured. Ordered by creation time, newest first, when omitted.
Fetch a carrier by ID. Requires carrier:read permission.
List carriers with pagination. Requires carrier:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a shipment by ID. Requires shipment:read permission.
Arguments (1)
Shipment ID to fetch
List shipments with pagination. Requires shipment:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a shipment package by ID. Requires shipment:read permission.
Arguments (1)
Shipment package ID to fetch
List shipment packages with pagination. Requires shipment:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a shipment item by ID. Requires shipment:read permission.
Arguments (1)
Shipment item ID to fetch
List shipment items with pagination. Requires shipment:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
getPlannedDelivery; requires plannedDelivery:read
Arguments (1)
Typed resource identifier
listPlannedDeliveries; requires plannedDelivery:list
Arguments (3)
Maximum number of records to return
Opaque cursor from the previous page
Optional customer associated with this planned delivery
getPlannedDeliveryItem; requires plannedDelivery:read
Arguments (1)
Typed resource identifier
listPlannedDeliveryItems; requires plannedDelivery:list
Arguments (4)
Maximum number of records to return
Opaque cursor from the previous page
Parent planned delivery identifier
Optional existing job identifying the requested contents
getShipmentItemAllocation; requires plannedDelivery:read
Arguments (1)
Typed resource identifier
listShipmentItemAllocations; requires plannedDelivery:list
Arguments (4)
Maximum number of records to return
Opaque cursor from the previous page
Existing physical shipment item identifier
Planned item receiving this allocation
getFulfillmentRequirement; tenant-scoped and permission checked
Arguments (1)
Id for this fulfillment specification
listFulfillmentRequirements; tenant-scoped and permission checked
Arguments (4)
Owning planned delivery
Include retained retired records, false by default
Maximum page size
Cursor from the previous page
getCustomerFulfillmentDefault; tenant-scoped and permission checked
Arguments (1)
Id for this fulfillment specification
listCustomerFulfillmentDefaults; tenant-scoped and permission checked
Arguments (4)
Explicit customer supplying defaults; never inferred from recipient or billing
Include retained retired records, false by default
Maximum page size
Cursor from the previous page
Authoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction
Arguments (1)
Delivery or item to compose; item composition also includes delivery-wide requirements
getShipmentItemEvidence; tenant-scoped evidence without inferred completion
Arguments (1)
id filter or identity
listShipmentItemEvidence; tenant-scoped evidence without inferred completion
Arguments (3)
shipmentItemId filter or identity
first filter or identity
after filter or identity
shipmentItemExecutionBalance; tenant-scoped evidence without inferred completion
Arguments (1)
shipmentItemId filter or identity
plannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion
Arguments (1)
plannedDeliveryItemId filter or identity
getRequirementEvidence; read-only, no inferred completion or macro gate
Arguments (1)
id; explicit assessment context
listRequirementEvidence; read-only, no inferred completion or macro gate
Arguments (3)
requirementId; explicit assessment context
first; explicit assessment context
after; explicit assessment context
assessFulfillmentRequirements; read-only, no inferred completion or macro gate
Arguments (4)
scope; explicit assessment context
Explicit gross execution stage: DISPATCH or RECEIPT; RETURN is not a completion basis
Possible values (3)
DISPATCHObserved dispatch quantities; independent of workflow status
RECEIPTObserved receipt quantities; independent of workflow status
RETURNObserved returned quantities; independent of workflow status
event; explicit assessment context
Possible values (3)
DISPATCHDispatch
DELIVERYDelivery
COLLECTIONCollection
Optional prospective event time, paired with event; used only to assess prerequisite ordering
Review a planned item using shared balances, effective requirements, assessment and authorized notes
Arguments (4)
Item to review
DISPATCH or RECEIPT, independent of tenant completion policy
Possible values (3)
DISPATCHObserved dispatch quantities; independent of workflow status
RECEIPTObserved receipt quantities; independent of workflow status
RETURNObserved returned quantities; independent of workflow status
Item notes page size, 1 through 200
Continue the item notes page
Assess current policy across every order line using explicitly attributed quantities
Read operational notes with current target permissions
Arguments (1)
id for authorized note retrieval
Read operational notes with current target permissions
Arguments (2)
integrationInstanceId for authorized note retrieval
key for authorized note retrieval
Read operational notes with current target permissions
Read operational notes with current target permissions
Fetch an order by ID. Requires order:read permission.
Fetch an order by external ID. Requires order:read permission.
Arguments (1)
External system identifier
List orders with pagination. Requires order:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch an order line by ID. Requires order:read permission.
Arguments (1)
Order line ID to fetch
List order lines with pagination. Requires order:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch an estimate by ID. Requires estimate:read permission.
Arguments (1)
Estimate ID to fetch
Fetch an estimate by external ID. Requires estimate:read permission.
Arguments (1)
External system identifier
List estimates with pagination, filtering, and sorting. Requires estimate:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch an estimate line by ID. Requires estimate:read permission.
Arguments (1)
Estimate line ID to fetch
List estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
List cost breakdowns for an estimate line. Requires estimate:read permission.
Arguments (3)
Estimate line ID to fetch breakdowns for
Number of items from the start
Cursor to start after
Fetch a single invoice by ID. Requires invoice:read permission.
List invoices with pagination, filtering, and sorting. Requires invoice:list permission.
Arguments (4)
Number of items to return from the start (forward pagination)
Cursor pointing to the item after which to start
Filter criteria for invoices
Sort order for results
Fetch a single invoice line by ID. Requires invoice:read permission.
Arguments (1)
Invoice line ID to fetch
List invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.
Arguments (4)
Number of items to return from the start (forward pagination)
Cursor pointing to the item after which to start
Filter criteria for invoice lines
Sort order for results
Fetch a single payment by ID. Requires payment:read permission.
List payments with pagination. Requires payment:list permission.
Arguments (4)
Number of items to return
Cursor to start after
Filter criteria (invoiceId optional)
Sort order
Fetch a single supplier by ID. Requires supplier:read permission.
Arguments (1)
Supplier ID to fetch
List suppliers with pagination, filtering, and sorting. Requires supplier:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single purchase order by ID. Requires purchaseOrder:read permission.
Arguments (1)
Purchase order ID to fetch
List purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single purchase order line by ID. Requires purchaseOrder:read permission.
Arguments (1)
Purchase order line ID to fetch
List purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single product by ID. Requires product:read permission.
List products with pagination, filtering, and sorting. Requires product:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.
Arguments (1)
Reservation ID
List material reservations with pagination. Requires jobMaterialReservation:list permission.
Arguments (4)
Number of items to return
Cursor to start after
Filter criteria (jobId optional)
Sort order
Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
Arguments (3)
TypeID of the customer to summarise (cus_01K…). Must belong to the caller's tenant; otherwise the payload comes back empty with a customerId: customer not found error.
Inclusive start of the window, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Filters orders by orderDate and estimates/invoices by issueDate. Omit for no lower bound; an unparseable value is ignored, not rejected.
Exclusive end of the window, in the same ISO-8601 date-time format as fromDate. Omit for no upper bound; an unparseable value is ignored, not rejected.
Fetch active production jobs with components, operations, and order context. Requires job:list.
Arguments (3)
Inclusive lower bound on the job's due date, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Omit for no lower bound; an unparseable value is ignored, not rejected.
Exclusive upper bound on the job's due date, in the same format as fromDate. Omit for no upper bound; an unparseable value is ignored.
Restrict the board to jobs in these statuses. Omit to return jobs in every status; an empty list matches no jobs.
Possible values (12)
DRAFTJob created but not yet confirmed
RFQAwaiting cost estimation
CONFIRMEDOrder confirmed, ready for production
PREPRESSArtwork preparation and plate-making
PRESSCurrently printing
POSTPRESSFinishing operations (binding, cutting, etc.)
PACKINGPacking for shipment
SHIPPEDDispatched to customer
COMPLETEDDelivered and closed
WAITINGOn hold pending external action
CANCELLEDJob cancelled
EXCEPTIONRequires attention due to error
Fetch all shipments for a given date with packages, items, and order details. Requires shipment:list.
Check whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.
Get a costing summary for a job including material and operation costs. Requires job:read.
Permission-filtered MicroSQL authoring metadata and its content version. Contains logical schema only, never physical database mappings.
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.
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. Validates only against tables the caller can list.
Arguments (1)
Query to analyze
Get a data clip by ID
Arguments (1)
TypeID of the clip to fetch (e.g. "dcl_01K…"). Resolves to null when no such clip exists in the caller's tenant.
List data clips for the current tenant
Arguments (4)
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
Cursor from a previous page's endCursor; the listing resumes with the clip after it. An unknown cursor is ignored and the page starts from the top.
Optional criteria narrowing which clips are listed.
Sort terms; only the first is applied. Defaults to the persistence layer's natural order when omitted.
Preview a MicroSQL query without saving (returns tabular results)
Arguments (1)
The MicroSQL query to run for preview. Nothing is persisted.
Analyze XML without executing queries; returns diagnostics and the live authoring vocabulary as JSON.
Losslessly export a report definition as XML.
Arguments (1)
Canonical definition to export.
List report data sources and their selectable columns.
List notification delivery attempts for a report run.
Arguments (1)
Report run identifier.
List starter definitions for creating reports.
List schedules pinned to a report version.
Arguments (1)
Report version identifier.
List recorded firings of a report schedule.
Arguments (1)
Report schedule identifier.
Read a report and its draft metadata by ID.
List reports in a cursor-paginated page.
Read an immutable report version by ID.
Arguments (1)
Report version identifier.
List published versions of a report.
Check a report definition without saving or executing it.
Arguments (2)
Report XML source.
Report definition JSON to validate.
Read the progress and outcome of a report run.
Arguments (1)
Report run identifier.
List report runs, optionally restricted to a published version.
Arguments (3)
Maximum number of records to return.
Continue after this resource identifier.
Restrict runs to this immutable report version.
List retained output files for a report run.
Arguments (1)
Report run identifier.
Fetch an external schema by ID. Requires externalSchema:read permission.
Arguments (1)
External schema ID to fetch
List external schemas with pagination and filtering. Requires externalSchema:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
List tenant API definitions, optionally restricted to one uploaded schema.
Arguments (3)
Maximum number of definitions to return.
Continue after this opaque cursor.
Uploaded external schema supplying the pinned API description.
Read a tenant API definition and its current compilation status.
Arguments (1)
API client definition identity.
List entries for an external schema. Requires externalSchema:read permission.
Arguments (5)
External schema ID to list entries for
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Get current tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
Get a specific version of tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
List version history for tenant configuration, newest first, with pagination. Requires tenantConfig:list permission.
Discover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.
Compare retained input facts and optionally inspect attributed stock. Read-only; no technical feasibility or execution readiness guarantee. Stock checking additionally requires warehouseStock:read.
Arguments (1)
Persisted or headless requirements and explicit current facts; inventory checking is opt-in.
Evaluate whether a component can be produced by the given work centers
Arguments (1)
What to evaluate (componentId or an inline spec) and, optionally, which work centers to evaluate against.
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.
Arguments (1)
What to analyse (componentId or an inline spec) and, optionally, which work centers to consider for routing recommendations.
Preview waste, yield, duration and constant-rate pace for a stored planned operation. Optionally assess its stored plan's item statuses and downstream dependencies, plus booked timing in an explicit schedule scenario. No writes or audit events. Inspect coverage and limitations; this is not a delivery-date guarantee.
Arguments (1)
Stored planned step and hypothetical cumulative progress.
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.
Arguments (1)
The job to audit plus the waste, yield and duration thresholds that classify findings as warning or critical. Each threshold falls back to its documented default when omitted.
Enriched production audit: same as auditProduction but additionally includes work center baseline metrics, production cell rankings, and live in-flight performance from LightTS progress hourly aggregates. Returns the same AuditVerdictOutput type with enrichments and livePerformance fields populated.
Arguments (1)
The job to audit plus the waste, yield and duration thresholds. Same shape as auditProduction; the enrichment layers are added by the resolver, not requested here.
Which build of the platform is answering. Compare across deployments to tell them apart, or across time to notice that the server changed under a cached set of workarounds.
Semantic search over GraphQL types (objects, inputs, enums)
Semantic search over GraphQL fields on types
Semantic search over GraphQL query operations
Semantic search over GraphQL mutation operations
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.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
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.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
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.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
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.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
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.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
Fetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.
Arguments (1)
TypeID (sbk_ prefix) of the backend to fetch.
List the calling tenant's storage backends. Requires storageBackend:list permission.
Arguments (4)
Maximum number of backends to return. Defaults to 100; values above the server's page-size limit (100) are rejected.
Forward-pagination cursor (an edge's cursor): the page starts at the backend immediately after it, in the requested sort order.
Narrows the backends returned. Omit to list all of the tenant's backends.
Ordering rules; only the first entry is applied, and both its field and direction are honoured. Omit to order by creation time, newest first.
Which storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.
Fetch a single archive job by id, scoped to the caller's tenant. Null if no such job exists. Requires archiveJob:read permission.
Arguments (1)
TypeID (prefix arj) of the archive job to fetch.
List the tenant's archive jobs as a cursor-paginated connection, filtered and sorted in the database. Requires archiveJob:list permission.
Arguments (4)
Number of items from the start of the page. Defaults to 100; values above 100 are rejected.
Cursor to start after — an ArchiveJobEdge.cursor value from a previous page. Resumes the listing at the row following that cursor, under the same filter and sort.
Optional name / slug / isEnabled filters. Omit to list every archive job in the tenant.
Ordering rules; only the first is applied. Omit to order by creation time, newest first.
A single archive execution by id, or null if no such execution exists in the caller's tenant. Requires archiveExecution:read permission.
Arguments (1)
TypeID of the execution to fetch, prefixed "arx" (e.g. "arx_01K…").
Run history for one archive job, newest run first (by startedAt), with pagination. Scoped to the caller's tenant. Requires archiveExecution:list permission.
Arguments (3)
TypeID of the archive job whose runs to list, prefixed "arj" (e.g. "arj_01K…").
Number of items from the start
Cursor to start after
A single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.
Folders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.
Arguments (4)
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
Cursor from a previous page's edge (a folder TypeID) to continue after. The listing resumes at the folder following that cursor, under the same filter and sort. A cursor that matches no folder in the result set is ignored and the first page is returned.
Narrow the result set by name and/or binding kind. Omit to list every folder in the tenant.
Sort keys; only the first is applied. Defaults to creation time, newest first, when omitted.
Read accepted message metadata and managed File references under its InboxFolder permissions.
Arguments (1)
InboxMessage ID passed as the event dataQuery $id.
Read a mailbox configuration in this tenant.
Arguments (1)
InboxFolder ID.
Read bounded mailbox runtime health without credentials or message content.
Arguments (1)
InboxFolder ID.
List mailbox configurations without credentials.
Arguments (2)
Page size between 1 and 100; defaults to 25.
Last InboxFolder ID from the previous page, ordered by ID.
Keyset page mailbox intake/status records. Requires inboxFolder:list.
Arguments (3)
Mailbox whose messages to list.
Page size, 1 to 100.
nextAfter from the previous page; omit for the first page.
Keyset page workflow delivery and execution status independently from intake status.
Arguments (3)
Mailbox whose deliveries to list.
Page size, 1 to 100.
nextAfter from the previous page; omit for the first page.
Read retained accepted MIME bytes with inbox, file, report, and Folder authorization.
Arguments (1)
Accepted message whose content to read.
Separately permissioned and audited access to bounded staged quarantine bytes; no File/Folder URL is exposed.
Arguments (4)
Quarantined message to inspect.
Audited reason for the inspection, 1 to 1000 UTF-8 bytes.
First byte to return; omit to start at the beginning.
Maximum bytes to return, 1 to 1048576.
Keyset page durable review, inspection, hold, replay, and delivery-dismissal audit records.
Bounded tenant-scoped page of hold owners, reasons, and expiry state.
Arguments (3)
Mailbox whose holds to list.
Page size, 1 to 100.
nextAfter from the previous page; omit for the first page.
Bounded sample of expired eligible and held messages, plus the next configured expiry.
Arguments (1)
Mailbox to preview.
Read whether the current sender and submission credential have explicit operator approval.
Arguments (1)
Mailbox whose sender approval to read.
Read safe outbound status for callers authorized to execute within the inbox.
Arguments (1)
Outbound message identifier returned when the reply was requested.
Keyset page safe outbox statuses for authorized operators, including unknown deliveries.
Arguments (3)
Mailbox whose outbox to list.
Page size, 1 to 100.
nextAfter from the previous page; omit for the first page.
Fetch a single concept by ID. Requires concept:read permission.
List the tenant's concepts with pagination. Requires concept:list permission.
Arguments (4)
Number of concepts to return from the start.
Cursor to page after.
Filter criteria.
Sort order.
Fetch a single knowledge note by ID. Requires knowledgeNote:read permission.
Arguments (1)
Knowledge note ID to fetch.
List knowledge notes with pagination and filtering. A direct query over the store; for situational relevance use retrieveKnowledge. Requires knowledgeNote:list permission.
Arguments (4)
Number of notes to return from the start.
Cursor to page after.
Filter criteria.
Sort order.
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.
Arguments (3)
Entities the caller is currently working with, as TypeIDs (e.g. "wcr_01K…"); each prefix names the entity kind. Retrieval expands the situational graph outward from these to find related knowledge.
Optional free-text intent. Ranks results by semantic similarity and pulls in graph-unreached notes as supporting.
Maximum number of notes to return per bucket.
Lineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.
Entities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.
Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
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.
Arguments (5)
TypeIDs of the entities to start the hypothetical walk from.
Hypothetical edges to union into the walk (never persisted).
Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".
Maximum traversal depth. Defaults to 5.
Graph to walk: "fulfillment", "provenance", or "structural". Defaults to "structural".
Fetch a component artwork file reference by ID. Requires componentArtworkFile:read permission.
Arguments (1)
Artwork file reference ID to fetch
List artwork file references for a component. Requires componentArtworkFile:list permission.
Arguments (1)
Component ID to list artwork files for
Validate and prepare a saved form Layout and original source signatures without producing inventory
Arguments (1)
Saved form and optional managed artwork selections
Render the saved form Layout from managed source PDFs, retaining each source signature identity
Arguments (1)
Saved form and optional managed artwork selections
Fetch an imposition spec by ID. Requires impositionSpec:read permission.
Arguments (1)
Imposition spec ID to fetch
Fetch an imposition spec by external ID. Requires impositionSpec:read permission.
Arguments (1)
External system identifier, resolved in the calling integration's namespace
List imposition specs for exactly one component or batch form. Requires impositionSpec:list permission.
Arguments (2)
List specifications owned by this form; omit componentId
Component ID to list imposition specs for
Derive finishing geometry without persistence. Requires impositionSpec:execute. Supply impositionSpecId or layout.
Arguments (1)
Stored imposition identity or inline layout to consolidate.
Plan explicit rectangular label lanes and reconcile SKU demand and overrun without persistence. Includes cyclic bleed clearances and stock length. Does not certify tooling, slitting, matrix stripping or rewind delivery.
Arguments (1)
Authoritative planning request and optional output settings.
Deprecated: Use planBookCover with typed job, component or headless inputs and shared units, then renderBookCover. Existing JSON requests remain supported.
Reconcile explicit softcover or case-wrap construction against a calibrated physical book block without persistence. Rejects inconsistent spine, face dimensions, recipe revision and binding direction. Does not generate production artwork.
Arguments (1)
Authoritative planning request and optional output settings.
Deprecated: Use planWideFormatTiling with LengthInput quantities, then renderWideFormatTiling with the typed plan. Existing JSON requests remain supported.
Plan native-size source crops and right/top overlaps without persistence. At most 256 panels; output panel dimensions 3–14400 PDF points. Row-major, bottom row first. No implicit scaling, assembly marks or device finishing instructions.
Arguments (1)
Legacy integer-micrometre JSON request and optional source page.
Verify a stored print/cut ZIP against independently supplied current geometry, bindings and tenant source PDFs. Requires impositionSpec:read, file:read and file:download. Refuses unavailable, failed, changed or inconsistent artifacts. Read-only; does not record approval or certify a device.
Arguments (1)
Bundle file and current plan/source bindings to compare.
Plan and independently validate a bounded batch of polygonal pieces without persistence. Deterministic orthogonal heuristic, not an optimum guarantee. At most 256 pieces and 4096 placed vertices; hole nesting requires explicit opt-in. Produces geometry only, not a production PDF or cutter programme.
Arguments (1)
Nesting requirements, optional artwork and cut-geometry export selection.
Preview imposition layout without creating records. Used for estimation when no component exists yet.
Arguments (1)
Preview imposition parameters (estimate mode)
List all available fold patterns from the catalog. Requires authentication.
Compose real source PDF pages using a previously calculated signature, repeat, cut-stack or wide-format tiling plan. Returns PDF bytes without persistence or cloud storage; does not calculate geometry or repeat forms by quantity. Requires impositionSpec:execute permission and the native PDF-Writer backend.
Arguments (1)
Separately calculated signature, repeat, cut-stack or wide-format tiling geometry and the source PDF bytes.
Render an imposition layout as SVG. Provide either impositionSpecId or layout. Requires impositionSpec:execute permission.
Arguments (1)
SVG render parameters
Calculate up to 256 native-scale panels with typed quantities. No PDF inspection, persistence, machine selection or cutting setup. Requires impositionSpec:read.
Arguments (1)
Design dimensions, usable panel limits, overlap and optional seams with explicit units.
Render one PDF page per typed panel, either from explicit geometry or identity-checked planning replay. Does not persist output. Source dimensions must match the design at native scale. Returns the existing inline PDF payload. Requires impositionSpec:execute.
Arguments (1)
Validated selected plan and the physical source PDF page to crop at native scale.
Resolve one book and calculate its block and cover. Job/component sources additionally require job:read, component:read and substrate:read. No persistence or automatic acceptance of inference.
Arguments (1)
Exactly one product source, physical overrides and explicit construction parameters, using shared units.
Validate and render the typed cover plan. Persisted snapshots require job:read, component:read and substrate:read and are checked for freshness. Returns inline PDF data; does not create files, batches or operations.
Arguments (1)
Selected typed plan and one preassembled exterior spread page at native scale.
Plan a gathered or explicitly nested cross-component book without writes or PDF downloads. Persisted routes additionally require job:read, component:read, substrate:read, componentArtworkFile:read and file:read. Existing JSON APIs are unchanged.
Arguments (1)
One job, a same-job component selection, or headless contributions with explicit assembly and source ranges.
Resolve a book and inspect actual PDFs without composing output. Requires impositionSpec:read. Managed routes also require all planning read permissions and file:download. Sources are limited to 16 MiB each and 32 MiB combined.
Arguments (1)
Typed planning request, headless documents when needed, and optional expected identities.
Render typed job, component-selection or headless book contributions from captured source bytes. Requires impositionSpec:execute. Managed routes also require planning read permissions and file:download. Checks expected identities when supplied. Returns all component outputs or none; no storage writes. Sources are limited to 16 MiB each and 32 MiB combined; combined output is limited to 32 MiB.
Arguments (1)
Typed planning request, headless documents when needed, and optional expected identities.
Read and inspect a retained print sheet product. Returns null for an absent or non-print product. Requires operation read permission; no file download or inventory change occurs.
Arguments (1)
Existing durable product identity within the current tenant.
Find every qualified signature of a job across existing plans, current operation work and historical retained products. Requires job, component, imposition-spec and operation read permissions. Reports unknown legacy identities explicitly; neither publication nor physical production is inferred.
Arguments (1)
Job selection, bounded page size, optional continuation and optional stock visibility.
Replan and validate managed source bytes for physical sheet products without writing records. Existing impositionSpec read and managed file download permissions are also required.
Arguments (1)
Existing component planning configuration and optional artwork selection.
Validate full-material fold geometry and retained production identity without writes or source downloads. Preserves historical printed artwork even when the current artwork changes.
Arguments (1)
Between one and 256 existing printed-input/folding-producer selections.
Validate one composed signature carrier against captured PDFs without producing output or writing records. Managed routes require existing planning reads and file download. Sources are limited to 16 MiB each and 32 MiB combined.
Arguments (1)
Existing source planning family and reviewed carrier arrangement.
Render one physical composed carrier through existing layout traversal, source snapshots and output-intent reconciliation. Uses impositionSpec:execute and managed planning/download permissions. Output is limited to 32 MiB; no storage or inventory writes.
Arguments (1)
Same preparation input, optionally guarded by reviewed carrier and book source identities.
Preview separation without persisted production records using existing source-observed carrier preparation. No routes, graph writes or inventory are created. Existing carrier source limits apply.
Arguments (3)
Existing job/component or headless carrier preparation input. Existing source download and planning permissions apply.
Optional staged guillotine geometry and remnant handling. Unresolved remnants are allowed in preview.
Physical occurrence grouping for the prepared carrier. Geometry and identities come from the existing preparation path.
Validate retained separation geometry and each output's original graph route without writes or source downloads. Historical artwork is preserved.
Arguments (1)
Retained carrier, cutting work and optional existing downstream route selections.
Plan rectangular roll labels through typed inputs without persistence or PDF inspection. Supports fixed lanes, bounded search, complete-repeat delivery and separate declared-limit assessments. Requires impositionSpec:read; persisted sources additionally require job:read, component:read, operation:read, substrate:read, componentArtworkFile:read and file:read.
Arguments (1)
Headless items or persisted job/component selection, optional overrides, production, delivery and limits with shared units.
Resolve a typed roll plan and inspect its actual PDFs without rendering. Returns identities for later freshness comparison. Requires impositionSpec:read; persisted inputs also require the planning read permissions and file:download.
Arguments (1)
Typed planning input, headless documents when applicable and optional expected freshness identities.
Resolve and render one roll-label repeat from typed job/component or headless inputs. Checks optional expected identities, validates actual source bytes and returns data without storage. Requires impositionSpec:execute and, for persisted sources, planning read permissions and file:download.
Arguments (1)
Typed planning input, headless documents when applicable and optional expected freshness identities.
Enumerate planned delivery rolls without PDFs or persistence. Re-resolves planning and checks identity on every continuation. Requires impositionSpec:read plus the same persisted-source/route permissions as planRollLabels; file:download is not required. Failed capability assessments remain separate from geometric planning and pagination does not authorize production release.
Arguments (1)
Retained planning input, optional bound continuation or first-page expected identity, and page size.
Fetch a prepress operation by ID. Requires prepressOperation:read permission.
Arguments (1)
Prepress operation ID
List prepress operations for a component. Requires prepressOperation:list permission.
Arguments (1)
Component ID to list prepress operations for
Fetch a preflight report by ID. Requires preflightReport:read permission.
Arguments (1)
Preflight report ID
List preflight reports for a component. Requires preflightReport:list permission.
Arguments (1)
Component ID to list reports for
Render a page of an artwork file to a JPEG preview (base64). Requires componentArtworkFile:read permission.
Arguments (1)
Artwork + page to render
Run preflight on supplied PDF bytes inline (not persisted). Requires preflightReport:read permission.
Arguments (1)
PDF bytes + profile
Render a page of supplied PDF bytes to a JPEG preview (base64) inline. Requires componentArtworkFile:read permission.
Arguments (1)
PDF bytes + page
Render a single ink separation (plate) of an artwork page to a grayscale PNG (base64). Requires componentArtworkFile:read permission.
Arguments (1)
Artwork + separation
Render a single ink separation (plate) from supplied PDF bytes to a grayscale PNG (base64) inline. Requires componentArtworkFile:read permission.
Arguments (1)
PDF bytes + separation
Extract ISO 19593-1 production steps from supplied PDF bytes inline (not persisted) — inspect before creating Operations. Requires operation:read permission.
Arguments (1)
PDF bytes
Fetch a substrate by ID. Requires substrate:read permission.
Arguments (1)
Substrate ID to fetch
Fetch a substrate by external ID. Requires substrate:read permission.
Arguments (1)
External system identifier
List substrates with pagination and filtering. Requires substrate:list permission.
Arguments (4)
Number of items from the start
Cursor to start after
Filter criteria
Sort order
Fetch a single substrate template line by ID. Requires substrateTemplateLine:read permission.
Arguments (1)
Substrate template line ID
List substrate template lines for a product template. Requires substrateTemplateLine:list permission.
Arguments (1)
Product template to list BOM lines for
Read the bridge JMF endpoint configuration for this controller. This does not enable direct POST /api/v1/jmf; that is settings.jmf (Settings › JMF signals). Requires controller:read.
Arguments (1)
Controller whose JMF config to read
Read the JMF DeviceID set on a work center ↔ device binding. Requires workCenter:read.
Arguments (1)
TypeID (wcd_…) of the binding to read. Returns null when the binding has no JMF DeviceID set (or does not exist in this tenant).
JSON submission history and queue identities associated with an execution record. Every id in it is a TypeID.
Arguments (1)
Exactly one operation, item or planned operation to inspect.
JSON execution observations, resolution evidence and application outcomes for a received envelope. Every id in it is a TypeID.
Arguments (1)
Observation fingerprint from ingestion diagnostics.
JSON correlation records for a queue entry, including retired attempts. Every id in it is a TypeID.
Arguments (2)
JMF DeviceID queue namespace.
QueueEntryID to inspect.
Fetch a single address by ID. Requires address:read permission.
Fetch an address by external ID. Requires address:read permission.
Arguments (1)
External system identifier (unique per tenant)
List addresses with pagination. Requires address:list permission.
Fetch a single business unit by ID. Requires businessunit:read permission.
Arguments (1)
Business unit ID to fetch
Fetch a business unit by external ID or code. Requires businessunit:read permission.
Arguments (2)
External system identifier
Business unit code
List business units with pagination. Requires businessunit:list permission.
List contacts with pagination. Requires contact:list permission.
Fetch a contact by its stable ID. Requires contact:read permission.
Fetch a contact by external ID or email. Requires contact:read permission.
Arguments (2)
External system identifier
Contact email address
Fetch a single cost category by ID. Requires costcategory:read permission.
Arguments (1)
Cost category ID to fetch
Fetch a cost category by external ID or code. Requires costcategory:read permission.
Arguments (2)
External system identifier
Cost category code
List cost categories with pagination. Requires costcategory:list permission.
Fetch a single cost center by ID. Requires costcenter:read permission.
Arguments (1)
Cost center ID to fetch
Fetch a cost center by external ID or code. Requires costcenter:read permission.
List cost centers with pagination. Requires costcenter:list permission.
Fetch a single cost rate by ID. Requires costrate:read permission.
Arguments (1)
Cost rate ID to fetch
List cost rates with pagination. Requires costrate:list permission.
Fetch a single customer by ID. Requires customer:read permission.
Arguments (1)
Customer ID to fetch
Fetch a customer by external ID. Requires customer:read permission.
Arguments (1)
External system identifier
List customers with pagination, filtering, and sorting. Requires customer:list permission.
Arguments (6)
Number of items to return from the start (forward pagination)
Number of items to return from the end (backward pagination)
Cursor pointing to the item after which to start
Cursor pointing to the item before which to start
Filter criteria for customers
Sort order for results
List customer price overrides. Requires customerPriceOverride:list permission.
Arguments (6)
Maximum number of overrides to return. Defaults to 25 when omitted; values above 100 are rejected.
Cursor to page after, taken from a previous page's endCursor. The listing resumes at the override following that cursor, under the same filter and sort.
Optional filter criteria. When omitted, all overrides in the tenant are listed.
Sort keys applied to the result set before paging. When omitted, overrides are ordered by creation date, newest first.
Fetch a single operation cost mapping by ID. Requires costcategory:read permission.
Arguments (1)
Operation cost mapping ID to fetch
List operation cost mappings. Requires costcategory:list permission.
Arguments (6)
Maximum number of mappings to return. Defaults to 25 when omitted; values above 100 are rejected.
Cursor from a previous page's pageInfo.endCursor. The listing resumes at the mapping following that cursor, under the same filter and sort.
Optional filter criteria; when omitted all of the tenant's mappings match.
Ordering terms. When omitted, mappings are ordered by creation date, newest first.
Fetch a single price bracket by ID. Requires priceBracket:read permission.
Arguments (1)
Price bracket ID
List price brackets with pagination. Requires priceBracket:list permission.
Fetch a single production cell by id, scoped to the caller's tenant. Null when no such production cell exists. Requires productionCell:read permission.
Arguments (1)
TypeID (prefix "pcl") of the production cell to fetch.
List the tenant's production cells as a paginated connection, with optional filtering and sorting. Requires productionCell:list permission.
Arguments (6)
Return the first N production cells after the cursor (forward pagination).
Return the last N production cells before the cursor (backward pagination).
Opaque cursor from a previous page's edge; results start after it.
Opaque cursor from a previous page's edge; results end before it.
Criteria narrowing which production cells are returned; omit for all of them.
Ordering terms, applied in order. Defaults to createdAt descending; all terms participate in keyset pagination.
Fetch a single recorded cost by ID. Requires recordedcost:read permission.
Arguments (1)
Recorded cost ID to fetch
List recorded costs with pagination. Requires recordedcost:list permission.
Fetch a single tax code by ID. Requires taxCode:read permission.
List tax codes with pagination. Requires taxCode:list permission.
Referenced by (0)
Exact type SDL
type Query {
"""
Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
"""
topicExamples(
"""Stable example names, returned in this order."""
names: [String!]!
): [TopicExample!]! @topic(names: ["commerce", "jobs", "logistics", "files", "workflows", "costing"])
"""
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.
"""
magicQuery(
"""The Magic Query string, e.g. 'jobs?limit=10,status=approved'."""
query: QueryScalar!
): JSON! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
"""
getMagicQuerySchema(
"""A Magic Query string; only the noun is required, e.g. 'jobs'."""
query: QueryScalar!
): MagicQuerySchema! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
"""
listMagicQueries: [MagicQueryInfo!]! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
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.
"""
getMagicQueryGraphQL(
"""A Magic Query string to resolve, e.g. 'jobs?limit=10'."""
query: QueryScalar!
): MagicQueryOperation! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
This instance's settings. Needs tenantPreferences:read or tenantConfig:read; each section then needs the permission that guarded its data before Settings existed, and is null with an error without it.
"""
settings: Settings! @topic(names: ["admin"])
"""
List all valid data change event topics, grouped by resource. Requires authentication.
"""
listDataChangeEventTopics: [DataChangeEventGroup!]! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
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.
"""
generateDefaultDataQuery(
"""
Event topic in `resource.verb` form (e.g. 'carrier.updated'). Only the resource part is used: it selects the `get{Resource}(id:)` query the generated document targets. Null is returned when no such query exists.
"""
topic: String!
): String @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Read up to 100 comments and events, oldest first, with an exclusive cursor. Includes comment capability, never apply authority.
"""
iacChangeTimeline(
"""Owning stack."""
stackId: IaCStackID!
"""Change Request whose timeline is read."""
changeId: IaCChangeID!
"""Exclusive entry ID from the previous page."""
after: ID
): IaCChangeTimeline! @topic(names: ["admin"])
"""
Read bounded plan highlights for at most 100 stack-local Change Requests.
"""
iacGitChangeReviews(
"""Owning stack."""
stackId: IaCStackID!
"""Change Request identities, at most 100."""
ids: [IaCChangeID!]!
): [IaCChangeReviewEntry!]! @topic(names: ["admin"])
"""
Read a safe projection of the original stored plan. No private inputs, approvals or execution authority are returned.
"""
iacGitChangeReview(
"""Owning stack."""
stackId: IaCStackID!
"""Change Request identity."""
id: IaCChangeID!
"""Return every planned action instead of the highlights."""
detail: Boolean
): IaCChangeReview @topic(names: ["admin"])
"""
Summarise a stack: revision, owner, last apply, resource kinds and pending changes. Requires stack read access.
"""
iacStackOverview(
"""Stack to summarise."""
stackId: IaCStackID!
): IaCStackOverview! @topic(names: ["admin"])
"""
List deployed resources and those only open Change Requests would create, with the last and pending Change Requests for each. Requires stack read access.
"""
iacStackResources(
"""Stack whose resources are listed."""
stackId: IaCStackID!
"""Only resources of this kind."""
kind: String
"""Exclusive last address from the previous page."""
after: String
): IaCStackResourcePage! @topic(names: ["admin"])
"""
List a stack's applied revisions, newest first, each linked to the Change Request that produced it. Requires stack read access.
"""
iacStackHistory(
"""Stack whose history is read."""
stackId: IaCStackID!
"""Exclusive fromSerial of the last revision on the previous page."""
before: String
): IaCStackHistoryPage! @topic(names: ["admin"])
"""
Read README.md at the root of the stack's main branch as UTF-8 text; null without main or without a root README. Refused with README_TOO_LARGE above 256 KiB. Requires stack read access.
"""
iacStackReadme(
"""Stack whose notes are read."""
stackId: IaCStackID!
): String @topic(names: ["admin"])
"""Read what the viewer may do on a stack, and who may apply its changes."""
iacStackPermissions(
"""Stack whose permissions are read."""
stackId: IaCStackID!
): IaCStackPermissions! @topic(names: ["admin"])
"""Discover the authenticated Git remote for an authorized stack."""
iacGitRepository(
"""Owning stack."""
stackId: IaCStackID!
): IaCGitRepositoryValue! @topic(names: ["admin"])
"""
Read a bounded source snapshot after tenant, IAM and stack-grant authorization.
"""
iacGitSnapshot(
"""Existing stack whose source is requested."""
stackId: IaCStackID!
): IaCGitSnapshotValue! @topic(names: ["admin"])
"""
List up to 100 Change Requests, newest first, optionally filtered by branch, status or author. Requires stack read access.
"""
iacGitChanges(
"""Owning stack."""
stackId: IaCStackID!
"""Exclusive last ID from the previous page."""
after: IaCChangeID
"""
Only Change Requests opened from this branch ref, e.g. refs/heads/feature.
"""
sourceRef: String
"""Only Change Requests in this status: draft, applied or cancelled."""
status: String
"""Only Change Requests opened by this user."""
authorId: UserID
): [IaCGitChangeValue!]! @topic(names: ["admin"])
"""Read one draft Change Request in its owning stack."""
iacGitChange(
"""Owning stack."""
stackId: IaCStackID!
"""Change Request identity."""
id: IaCChangeID!
): IaCGitChangeValue @topic(names: ["admin"])
"""
Read immutable public GitHub package bytes for editor intelligence; validates lock integrity and creates no executable identity.
"""
iacModulePackages(
"""Stack whose read permission is checked."""
stackId: IaCStackID!
"""
Public bindings, original module lock metadata and revision; no IaC resource declarations or private inputs.
"""
request: String!
): IaCHostedValue! @topic(names: ["admin"])
"""
Non-executable advisory plan; persists no source, approval, lease or execution state.
"""
iacAdvisoryPlan(
"""Stack whose current state is inspected."""
stackId: IaCStackID!
"""
Complete ProjectInput JSON with dirty root files, target and private variables. Remote packages are server-owned.
"""
project: String!
"""Bypass immutable content caches for this plan and its apply recheck."""
fullRefresh: Boolean
): IaCHostedValue! @topic(names: ["admin"])
"""Read-only coordinator capability; ordinary clients cannot invoke it."""
iacAdvisorySnapshot(
"""Stack id (stk_…)."""
stackId: IaCStackID!
): IaCHostedValue! @topic(names: ["admin"])
"""
Reconcile a lost Apply response. Only the planning principal may inspect the result.
"""
iacApplyStatus(
"""Owning stack."""
stackId: IaCStackID!
"""Server plan whose committed outcome is requested."""
planId: IaCPlanID!
): IaCHostedValue! @topic(names: ["admin"])
"""List stacks visible to this user, up to 100 per page."""
iacStacks(
"""Deployment environment assertion."""
environment: String!
"""Last stack id from the previous page."""
after: IaCStackID
): [IaCStackValue!]! @topic(names: ["admin"])
"""Read current deployment state; source is held separately in Git."""
iacStackState(
"""Stack id (stk_…)."""
stackId: IaCStackID!
): IaCHostedValue! @topic(names: ["admin"])
"""
List a stack's secrets by name with their version history, never their values. Requires stack read access.
"""
iacStackSecrets(
"""Stack whose secrets are listed."""
stackId: IaCStackID!
): [IaCStackSecret!]! @topic(names: ["admin"])
"""
List the current value of every variable the stack holds, set ones only, with secrets listed by name and never by value. Requires stack read access.
"""
iacStackValues(
"""Stack whose values are listed."""
stackId: IaCStackID!
): [IaCStackVariable!]! @topic(names: ["admin"])
"""
List the variables a commit's source declares, in declaration order, for checking that a stack holds a value for each before promoting that commit. Requires stack read access.
"""
iacDeclaredVariables(
"""Stack whose repository holds the commit."""
stackId: IaCStackID!
"""
Commit to read; omitted reads main. Without main and without a commit the list is empty.
"""
commit: String
): [IaCDeclaredVariable!]! @topic(names: ["admin"])
"""
Read a stack's rules; a stack that never set any reads the defaults. Requires stack read access.
"""
iacStackRules(
"""Stack whose rules are read."""
stackId: IaCStackID!
): IaCStackRules! @topic(names: ["admin"])
"""Health check endpoint"""
ping: String! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""Fetch a job by ID. Requires job:read permission."""
getJob(
"""Job ID to fetch"""
id: JobID!
): JobState @topic(names: ["jobs"]) @topic_example(names: ["production.read-job"])
"""Fetch a job by external ID. Requires job:read permission."""
getJobBy(
"""External system identifier"""
externalId: String
): JobState @topic(names: ["jobs"])
"""List jobs with pagination and filtering. Requires job:list permission."""
listJobs(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: JobFilterInput
"""Sort order"""
sort: [JobSortInput!]
): JobConnection! @topic(names: ["jobs"])
"""
Aggregate jobs with optional filtering. Returns count, sum, avg, min, max. Requires job:list permission.
"""
aggregateJobs(
"""Filter criteria (same filters as listJobs)"""
filter: JobFilterInput
): JobAggregate! @topic(names: ["jobs"])
"""
Resolve supplied assembly data and optionally return an SVG using generic hints and vertical heuristics. Requires job:read. No persistence.
"""
resolveAssembly(
"""
Headless components and optional explicit graph; no persisted lookup or writes.
"""
input: ResolveAssemblyInput!
): ResolvedAssembly! @topic(names: ["jobs"])
"""
Read a tenant-scoped job assembly, report uncertainties and optionally generate its SVG. Requires job:read and component:read. Does not persist inference.
"""
resolveJobAssembly(
"""Job whose current components and authored graph should be resolved."""
jobId: JobID!
): JobAssemblyResolution! @topic(names: ["jobs"])
"""Fetch a job group by ID. Requires jobGroup:read permission."""
getJobGroup(
"""Job group ID"""
id: JobGroupID!
): JobGroupState @topic(names: ["jobs"])
"""List job groups with pagination. Requires jobGroup:list permission."""
listJobGroups(
"""Filter by order ID"""
orderId: OrderID
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): JobGroupConnection! @topic(names: ["jobs"])
"""Fetch one batch; tenant scoped"""
getBatch(
"""Identifier to fetch"""
id: BatchID!
): Batch @topic(names: ["jobs"])
"""List Batches with bounded pagination"""
listBatches(
"""Maximum page size"""
first: Int
"""Continue after this cursor"""
after: String
"""Filter by external ID in the caller namespace"""
externalId: String
): BatchConnection! @topic(names: ["jobs"])
"""Fetch one batchComponent; tenant scoped"""
getBatchComponent(
"""Identifier to fetch"""
id: BatchComponentID!
): BatchComponent @topic(names: ["jobs"])
"""List BatchComponents with bounded pagination"""
listBatchComponents(
"""Maximum page size"""
first: Int
"""Continue after this cursor"""
after: String
"""Filter by parent batch"""
batchId: BatchID
"""Filter by external ID in the caller namespace"""
externalId: String
): BatchComponentConnection! @topic(names: ["jobs"])
"""Fetch one batchContribution; tenant scoped"""
getBatchContribution(
"""Identifier to fetch"""
id: BatchContributionID!
): BatchContribution @topic(names: ["jobs"])
"""List BatchContributions with bounded pagination"""
listBatchContributions(
"""Maximum page size"""
first: Int
"""Continue after this cursor"""
after: String
"""Find work assigned to a batch"""
batchId: BatchID
"""Find batches containing source job work"""
jobId: JobID
"""Filter by original component"""
componentId: ComponentID
"""Find work assigned to a form"""
batchComponentId: BatchComponentID
): BatchContributionConnection! @topic(names: ["jobs"])
"""
Fetch a product template by ID. Requires productTemplate:read permission.
"""
getProductTemplate(
"""Product template ID"""
id: ProductTemplateID!
): ProductTemplateState @topic(names: ["productTemplates"]) @topic_example(names: ["production.read-template"])
"""
List product templates with optional filters, sorted by name. Requires productTemplate:list permission.
"""
listProductTemplates(
"""Filter by SKU (exact match)"""
sku: String
"""Filter by active status"""
isActive: Boolean
"""Filter by category (exact match)"""
category: String
"""Filter by status (DRAFT or PUBLISHED)"""
status: String
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ProductTemplateConnection! @topic(names: ["productTemplates"]) @topic_example(names: ["production.browse-templates"])
"""
List published versions of a template with pagination. Requires productTemplate:read permission.
"""
listProductTemplateVersions(
"""Product template ID"""
templateId: ProductTemplateID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ProductTemplateVersionConnection! @topic(names: ["productTemplates"]) @topic_example(names: ["production.browse-template-versions"])
"""
Fetch a specific published version. Requires productTemplate:read permission.
"""
getProductTemplateVersion(
"""Product template ID"""
templateId: ProductTemplateID!
"""Version number"""
version: Int!
): ProductTemplateVersionState @topic(names: ["productTemplates"]) @topic_example(names: ["production.read-template-version"])
"""Fetch a milestone by ID. Requires milestone:read permission."""
getMilestone(
"""Milestone ID to fetch"""
id: MilestoneID!
): MilestoneState @topic(names: ["jobs"])
"""
Fetch a milestone by any of its external ids. Every supplied id must match; with none, returns null. Requires milestone:read permission.
"""
getMilestoneBy(
"""External system identifier"""
externalId: String
"""External id of the record marking the start"""
externalStartId: String
"""External id of the record marking the completion"""
externalCompletionId: String
): MilestoneState @topic(names: ["jobs"])
"""
List milestones with pagination and filtering. Requires milestone:list permission.
"""
listMilestones(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: MilestoneFilterInput
"""Sort order"""
sort: [MilestoneSortInput!]
): MilestoneConnection! @topic(names: ["jobs"])
"""Fetch a component by ID. Requires component:read permission."""
getComponent(
"""Component ID to fetch"""
id: ComponentID!
): ComponentState @topic(names: ["jobs"])
"""Fetch a component by external ID. Requires component:read permission."""
getComponentBy(
"""External system identifier"""
externalId: String
): ComponentState @topic(names: ["jobs"])
"""
List components with pagination and filtering. Requires component:list permission.
"""
listComponents(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: ComponentFilterInput
"""Sort order"""
sort: [ComponentSortInput!]
): ComponentConnection! @topic(names: ["jobs"])
"""
Aggregate components with optional filtering. Returns count, sum, avg, min, max. Requires component:list permission.
"""
aggregateComponents(
"""Filter criteria (same filters as listComponents)"""
filter: ComponentFilterInput
): ComponentAggregate! @topic(names: ["jobs"])
"""
Fetch a component section by ID. Requires componentGroup:read permission.
"""
getComponentGroup(
"""Component section ID to fetch"""
id: ComponentGroupID!
): ComponentGroupState @topic(names: ["jobs"])
"""
List component sections, optionally scoped to a job. Requires componentGroup:list permission.
"""
listComponentGroups(
"""
Filter by parent job ID. Omit to list every component section in the tenant.
"""
jobId: JobID
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ComponentGroupConnection! @topic(names: ["jobs"])
"""Fetch an operation by ID. Requires operation:read permission."""
getOperation(
"""Operation ID to fetch"""
id: OperationID!
): OperationState @topic(names: ["jobs"])
"""Fetch an operation by external ID. Requires operation:read permission."""
getOperationBy(
"""External system identifier"""
externalId: String
): OperationState @topic(names: ["jobs"])
"""
List operations with pagination and filtering. Requires operation:list permission.
"""
listOperations(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: OperationFilterInput
"""Sort order"""
sort: [OperationSortInput!]
): OperationConnection! @topic(names: ["jobs"])
"""
Aggregate operations with optional filtering. Returns count, sum, avg, min, max. Requires operation:list permission.
"""
aggregateOperations(
"""Filter criteria (same filters as listOperations)"""
filter: OperationFilterInput
): OperationAggregate! @topic(names: ["jobs"])
"""
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.
"""
getOperationParameterSchema(
"""The operation kind to retrieve the parameter schema for"""
kind: String!
): JSON @topic(names: ["jobs"])
"""Fetch a script by ID. Requires script:read permission."""
getScript(
"""Script ID to fetch"""
id: ScriptID!
): ScriptState @topic(names: ["scripting"])
"""Fetch a script by name. Requires script:read permission."""
getScriptByName(
"""Script name to fetch"""
name: String!
): ScriptState @topic(names: ["scripting"])
"""A script's history, newest first. Requires script:read permission."""
listScriptVersions(
"""Script whose history to list"""
scriptId: ScriptID!
"""Number of versions from the start"""
first: Int
"""Cursor to start after"""
after: String
): ScriptVersionConnection! @topic(names: ["scripting"])
"""Fetch one version of a script. Requires script:read permission."""
getScriptVersion(
"""Script the version belongs to"""
scriptId: ScriptID!
"""Version number to fetch"""
version: Int!
): ScriptVersionState @topic(names: ["scripting"])
"""
List scripts with pagination and filtering. Requires script:list permission.
"""
listScripts(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: ScriptFilterInput
"""Sort order"""
sort: [ScriptSortInput!]
): ScriptConnection! @topic(names: ["scripting"])
"""
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.
"""
listLuaSamples(
"""Only samples for this scripting role (default: all)"""
role: LuaScriptRole
"""Only samples of this tier (default: all)"""
tier: LuaSampleTier
): [LuaSampleSummary!]! @topic(names: ["scripting"])
"""Fetch one Lua sample with its runnable source. Requires script:read."""
getLuaSample(
"""Sample id from listLuaSamples"""
id: String!
): LuaSample @topic(names: ["scripting"])
"""
Type definitions for a scripting role, rendered from the surface the validator checks against. Requires script:read.
"""
luaTypeDefinitions(
"""Which scripting surface to describe"""
role: LuaScriptRole!
): String! @topic(names: ["scripting"])
"""
Structured ctx.* or bridge.* surface for editor completions and hover. Requires script:read.
"""
luaApiSurface(
"""Which scripting surface to describe"""
role: LuaScriptRole!
): [LuaApiEntry!]! @topic(names: ["scripting"])
"""Read a BOT service account. Returns null for HUMAN and KIOSK accounts."""
getServiceAccount(
"""Service account identifier"""
id: UserID!
): UserState @topic(names: ["admin", "iam"])
"""Read an existing user without claiming IaC ownership."""
getExistingUser(
"""User identifier"""
id: UserID!
): ExistingUser @topic(names: ["admin", "iam"])
"""
Look up an existing user by email or external identifier without claiming IaC ownership.
"""
getExistingUserBy(
"""User email address"""
email: String
"""External system identifier"""
externalId: String
): ExistingUser @topic(names: ["admin", "iam"])
"""Fetch a user by ID. Requires user:read permission."""
getUser(
"""User ID to fetch"""
id: UserID!
): UserState @topic(names: ["admin", "iam"])
"""Fetch a user by external ID or email. Requires user:read permission."""
getUserBy(
"""External system identifier"""
externalId: String
"""User email address"""
email: String
): UserState @topic(names: ["admin", "iam"])
"""
List users with pagination and filtering. Requires user:list permission.
"""
listUsers(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: UserFilterInput
"""Sort order"""
sort: [UserSortInput!]
): UserConnection! @topic(names: ["admin", "iam"])
"""
Conditional authoring availability and supported actions, business attributes, operators and limits. Metadata only; does not grant access.
"""
iamAuthoringCapabilities: IAMAuthoringCapabilities! @topic(names: ["admin"])
"""
Simulate a draft alongside a user's attached policies, or replacing one attachment. Requires iam:listUserPolicies and iam:readPolicy. Supplied time, network and sample values are simulation only; no resource records are read or permissions changed.
"""
previewIAMPolicy(
"""User, draft document and simulated conditions"""
input: IAMPolicyPreviewInput!
): IAMPolicyPreview! @topic(names: ["admin"])
"""Read a conditional policy attachment in the current tenant."""
getConditionalIAMPolicyAttachment(
"""Policy attachment identifier"""
id: UserPolicyAttachmentID!
): ConditionalIAMPolicyAttachment @topic(names: ["admin"])
"""Read a policy attachment in the current tenant."""
getIAMPolicyAttachment(
"""Policy attachment identifier"""
id: UserPolicyAttachmentID!
): IAMPolicyAttachment @topic(names: ["admin"])
"""
List all available IAM actions grouped by resource. Requires authentication.
"""
listIAMActions: [IAMActionGroup!]! @topic(names: ["admin"])
"""
Who the caller is and which tenant they are acting in. Requires authentication but no permission: a caller asking who they are needs no authority over anything.
"""
me: Viewer! @topic(names: ["admin"])
"""Get current user's effective permissions. Requires authentication."""
myEffectivePermissions: MyPermissions! @topic(names: ["admin"])
"""
Fetch an IAM policy with its revision. Requires iam:readPolicy permission.
"""
getConditionalIAMPolicy(
"""Policy ID to fetch"""
id: IAMPolicyID!
): ConditionalIAMPolicyState @topic(names: ["admin"])
"""Fetch an IAM policy by ID. Requires iam:readPolicy permission."""
getIAMPolicy(
"""Policy ID to fetch"""
id: IAMPolicyID!
): IAMPolicyState @topic(names: ["admin"])
"""
List IAM policies with pagination. Requires iam:listPolicies permission.
"""
listIAMPolicies(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: IAMPolicyFilterInput
"""Sort order"""
sort: [IAMPolicySortInput!]
): IAMPolicyConnection! @topic(names: ["admin"])
"""
List policies attached to a user. Requires iam:listUserPolicies permission.
"""
listUserPolicies(
"""User ID to list policies for"""
userId: UserID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): IAMPolicyConnection! @topic(names: ["admin"])
"""
Compile XML and analyze shared workflow contracts without executing operations; JSON analysis result
"""
analyzeWorkflowSource(
"""
Workflow XML document to compile and validate without saving or executing it
"""
sourceXML: String!
): String! @topic(names: ["workflows"])
"""Fetch a single workflow by ID. Requires workflow:read permission."""
getWorkflow(
"""Workflow ID to fetch"""
id: WorkflowID!
): WorkflowState @topic(names: ["workflows"]) @topic_example(names: ["prepress.read-workflow"])
"""List workflows with pagination. Requires workflow:list permission."""
listWorkflows(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: WorkflowFilterInput
"""Sort order"""
sort: [WorkflowSortInput!]
): WorkflowConnection! @topic(names: ["workflows"])
"""
Read authoritative workflow XML for IaC, including canonical exports of legacy versions
"""
getWorkflowVersionSource(
"""
Workflow version whose original source or canonical XML export should be returned
"""
id: WorkflowVersionID!
): WorkflowVersionSource @topic(names: ["workflows"])
"""
Fetch a single workflow version by ID. Requires workflow:read permission.
"""
getWorkflowVersion(
"""Version ID to fetch"""
id: WorkflowVersionID!
): WorkflowVersionState @topic(names: ["workflows"])
"""
List workflow versions with pagination. Requires workflow:list permission.
"""
listWorkflowVersions(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: WorkflowVersionFilterInput
"""Sort order"""
sort: [WorkflowVersionSortInput!]
): WorkflowVersionConnection! @topic(names: ["workflows"])
"""
Get the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.
"""
getWorkflowSchema: String! @topic(names: ["workflows"])
"""Compile Journey XML without saving or executing steps."""
analyzeJourneySource(
"""Journey XML source to analyze without saving it."""
sourceXML: String!
): JourneyAuthoringAnalysis! @topic(names: ["surfaces"])
"""Fetch a single journey by ID, if the caller may see it."""
getJourney(
"""
TypeID of the journey to fetch (prefix `jny`). Returns null when it does not exist or the caller's scope/domain grants do not admit it — a hidden journey is indistinguishable from a missing one.
"""
id: JourneyID!
): Journey @topic(names: ["surfaces"])
"""
Fetch a journey by its stable handle (deep links / anchored launches), if the caller may see it.
"""
getJourneyByHandle(
"""
The journey's stable handle (the slug from its definition's `id`), unique within the tenant. Returns null when unknown or not visible to the caller.
"""
handle: String!
): Journey @topic(names: ["surfaces"])
"""
List the caller's visible journey library (own personal + their teams' + instance).
"""
listJourneys(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""
Cursor from a previous page's `endCursor` — the page starts at the journey after it. An unresolvable cursor is ignored and the first page is returned.
"""
after: String
"""
Optional handle / status filter, narrowing the journeys the caller may already see. It can never widen visibility.
"""
filter: JourneyFilterInput
"""
Ordering clauses; only the first is applied. Defaults to UPDATED_AT descending.
"""
sort: [JourneySortInput!]
): JourneyConnection! @topic(names: ["surfaces"])
"""
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.
"""
getJourneyVersion(
"""TypeID of the journey version to fetch (prefix `jnv`)."""
id: JourneyVersionID!
): JourneyVersion @topic(names: ["surfaces"])
"""
List all versions of a journey, newest first (authoring history), if the caller may see it.
"""
listJourneyVersions(
"""
TypeID of the journey whose version history to list (prefix `jny`). Returns an empty page when the journey is unknown or not visible to the caller.
"""
journeyId: JourneyID!
"""Page size. Omitted returns up to the default page size."""
first: Int
"""
Cursor from a previous page's `endCursor` — the page starts at the version after it. An unresolvable cursor is ignored and the first page is returned.
"""
after: String
): JourneyVersionConnection! @topic(names: ["surfaces"])
"""
Analyze Workspace XML and Lua without saving, executing handlers or querying business data. Requires Workspace authoring permission.
"""
analyzeWorkspaceSource(
"""Workspace XML source to analyze without saving it."""
sourceXML: String!
"""Server Lua source to type-check alongside the XML."""
serverLua: String!
): WorkspaceAuthoringAnalysis! @topic(names: ["surfaces"])
"""Fetch a single workspace by ID, if the caller may see it."""
getWorkspace(
"""
TypeID of the workspace to fetch (prefix `wks`). Returns null when it does not exist or the caller may not see it.
"""
id: WorkspaceID!
): Workspace @topic(names: ["surfaces"])
"""
Fetch a workspace by its stable handle (deep links / anchored launches), if the caller may see it.
"""
getWorkspaceByHandle(
"""
The workspace's stable handle (its definition's `id`), unique within the tenant. Returns null when unknown or not visible to the caller.
"""
handle: String!
): Workspace @topic(names: ["surfaces"])
"""
List the caller's visible workspace library (own personal + their teams' + instance).
"""
listWorkspaces(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""
Cursor from a previous page's `endCursor`; results resume after it. An unresolvable cursor is ignored and the first page is returned.
"""
after: String
"""
Optional criteria (handle, computed status) narrowing the visible workspaces.
"""
filter: WorkspaceFilterInput
"""
Ordering terms; only the first is applied. Defaults to UPDATED_AT / DESC.
"""
sort: [WorkspaceSortInput!]
): WorkspaceConnection! @topic(names: ["surfaces"])
"""
Author-only XML/Lua source envelope for one Workspace version. Compiler artifacts remain internal.
"""
getWorkspaceSource(
"""Workspace version to inspect or invoke."""
versionId: WorkspaceVersionID!
): String @topic(names: ["surfaces"])
"""
Runs a declared read-only Lua loader on the current published Workspace version; returns JSON.
"""
loadWorkspaceData(
"""Workspace version to inspect or invoke."""
versionId: WorkspaceVersionID!
"""Name of the declared server Lua handler."""
handler: String!
"""
JSON object passed to the handler and validated against its input contract.
"""
inputJSON: String!
): String! @topic(names: ["surfaces"])
"""
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.
"""
getWorkspaceVersion(
"""TypeID of the workspace version to fetch (prefix `wsv`)."""
id: WorkspaceVersionID!
): WorkspaceVersion @topic(names: ["surfaces"])
"""
List all versions of a workspace, newest first (authoring history), if the caller may see it.
"""
listWorkspaceVersions(
"""
TypeID of the workspace whose versions to list (prefix `wks`). Returns an empty page when unknown or not visible to the caller.
"""
workspaceId: WorkspaceID!
"""Page size. Omitted returns up to the default page size."""
first: Int
"""
Cursor from a previous page's `endCursor`; results resume after it. An unresolvable cursor is ignored and the first page is returned.
"""
after: String
): WorkspaceVersionConnection! @topic(names: ["surfaces"])
"""
Read, compile and type-check a Portal site document without saving it. Returns `valid`; `diagnostics` (each with the model `path`, `message`, `severity` error or warning, and the original `sourceRange`); `projection`, the document in its model shape; `pages`, keyed by page pointer (`/pages/0`), with each page's server Lua `exports` in source order, so an editor can offer a handler for an export that has none; `components`, each site component's `security` and `events` with their inferred input and output schemas; and `locations`, source ranges by model pointer.
"""
analyzePortalSiteSource(
"""
Complete Portal site document XML to analyze without saving or publishing it.
"""
sourceXML: String!
): JSON! @topic(names: ["surfaces"])
"""
Read a `.portal` page or component file into the model's shape without saving anything. Returns `valid`; `identified`, true when the file names its part (`<page route>`, `<component name>`) and false for bare blocks, whose route or name the caller supplies; `part`, the `portal_page` or `portal_component` model object, or null when the file cannot be read; and `diagnostics`, each with its model `path`, `message`, `severity` and `sourceRange` in the file.
"""
importPortalPartSource(
"""Whether the file holds a page or a component."""
kind: PortalPartKind!
"""The `.portal` file's text: the part's element, or its bare blocks."""
source: String!
): JSON! @topic(names: ["surfaces"])
"""
The bundled component library: its version and every component with its `.portal` text and model object.
"""
portalComponentLibrary: PortalComponentLibrary! @topic(names: ["surfaces"])
"""Read one Portal in this tenant, or null when it does not exist."""
getPortal(
"""Portal to read."""
id: PortalID!
): Portal @topic(names: ["surfaces"])
"""List this tenant's Portals in creation order."""
listPortals(
"""Page size, 0 to 100; default 25. Zero returns only the total count."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalConnection! @topic(names: ["surfaces"])
"""
List the custom domain aliases reserved for a Portal, with their last known status.
"""
listPortalDomains(
"""Portal whose aliases to list."""
id: PortalID!
): [PortalDomain!]! @topic(names: ["surfaces"])
"""Read one Portal site, or null when it does not exist."""
getPortalSite(
"""Site to read."""
id: PortalSiteID!
): PortalSite @topic(names: ["surfaces"])
"""List the sites of a Portal in creation order."""
listPortalSites(
"""Portal whose sites to list."""
portalId: PortalID!
"""Page size, 0 to 100; default 25. Zero returns only the total count."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalSiteConnection! @topic(names: ["surfaces"])
"""
Read one immutable site source snapshot, or null when it does not exist.
"""
getPortalSiteVersion(
"""Snapshot to read."""
id: PortalSiteVersionID!
): PortalSiteVersion @topic(names: ["surfaces"])
"""
Read a site version's source as typed parts (pages, components, routes, tools, libraries, layouts, styles, assets) with the canonical `source`, or null when the version does not exist. A sibling of `getPortalSiteVersion`, so the parts never enter IaC state. Fails closed when the stored source no longer passes the current reading rules (it was saved under rules that have since changed): the error carries `extensions.code` `PORTAL_SITE_SOURCE_UNREADABLE`, and the snapshot itself is still readable with `getPortalSiteVersion`.
"""
getPortalSiteDocument(
"""Site version whose source to read."""
versionId: PortalSiteVersionID!
): PortalSiteDocument @topic(names: ["surfaces"])
"""List the source snapshots of a site in creation order."""
listPortalSiteVersions(
"""Site whose snapshots to list."""
siteId: PortalSiteID!
"""Page size, 0 to 100; default 25. Zero returns only the total count."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalSiteVersionConnection! @topic(names: ["surfaces"])
"""
Render one page of a site snapshot to HTML for authoring preview. Business-data access is denied while previewing.
"""
previewPortalSite(
"""Snapshot to render; it need not be published."""
versionId: PortalSiteVersionID!
"""Request path of the page to render, such as `/`."""
path: String!
): String! @topic(names: ["surfaces"])
"""Read one PortalUser, or null when it does not exist."""
getPortalUser(
"""PortalUser to read."""
id: PortalUserID!
): PortalUser @topic(names: ["surfaces"])
"""List this tenant's PortalUsers in stable identifier order."""
listPortalUsers(
"""Page size, 0 to 100; default 25."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalUserConnection! @topic(names: ["surfaces"])
"""Read one Portal membership, or null when it does not exist."""
getPortalMembership(
"""Membership to read."""
id: PortalMembershipID!
): PortalMembership @topic(names: ["surfaces"])
"""List the memberships of a Portal in stable identifier order."""
listPortalMemberships(
"""Portal whose memberships to list."""
portalId: PortalID!
"""Page size, 0 to 100; default 25."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalMembershipConnection! @topic(names: ["surfaces"])
"""
Read one Portal API credential's metadata, or null when it does not exist. The secret is never returned.
"""
getPortalAPICredential(
"""Credential to read."""
id: PortalAPICredentialID!
): PortalAPICredential @topic(names: ["surfaces"])
"""
List the API credentials issued for a Portal in stable identifier order, without their secrets.
"""
listPortalAPICredentials(
"""Portal whose credentials to list."""
portalId: PortalID!
"""Page size, 0 to 100; default 25."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalAPICredentialConnection! @topic(names: ["surfaces"])
"""
Read one Portal login ticket's metadata, or null when it does not exist. The secret is never returned.
"""
getPortalLoginTicket(
"""Ticket to read."""
id: PortalLoginTicketID!
): PortalLoginTicket @topic(names: ["surfaces"])
"""
List the login tickets issued for a Portal in stable identifier order, without their secrets.
"""
listPortalLoginTickets(
"""Portal whose tickets to list."""
portalId: PortalID!
"""Page size, 0 to 100; default 25."""
first: Int
"""
Cursor from a previous page's edge or pageInfo; omit for the first page.
"""
after: String
): PortalLoginTicketConnection! @topic(names: ["surfaces"])
"""Read the authoring definition and assignments."""
mcpTool(
"""Tool identity."""
id: MCPToolID!
): MCPTool @topic(names: ["scripting"])
"""
The caller's tool catalog: enabled, published tools assigned to them directly or through a team. Any signed-in user; assignment is the grant.
"""
myMCPTools: [MyMCPTool!]! @topic(names: ["scripting"])
"""
The caller's own finished tool invocations, newest first. Nobody else's are ever listed; still-running ones are left out.
"""
myMCPToolInvocations(
"""
Only invocations with one of these keys (at most 100, else a LIST_TOO_LONG error; an empty list matches nothing).
"""
idempotencyKeys: [String!]
"""Page size; defaults to 20, at most 100."""
first: Int
"""Cursor to continue after."""
after: String
): MCPToolInvocationConnection! @topic(names: ["scripting"])
"""List tenant tools for administration; not the end-user catalog."""
mcpTools: [MCPTool!]! @topic(names: ["scripting"])
"""Read immutable publication history."""
mcpToolVersions(
"""Tool identity."""
id: MCPToolID!
): [MCPToolVersion!]! @topic(names: ["scripting"])
"""Infer and decorate a tool contract without saving or running it."""
analyzeMCPToolSource(
"""Lua source; never executed by analysis."""
source: String!
"""Input metadata overlay."""
inputAnnotations: String
"""Output metadata overlay."""
outputAnnotations: String
): MCPToolAnalysis! @topic(names: ["scripting"])
"""Fetch one integration. Requires integration:read permission."""
getIntegration(
"""TypeID of the integration (prefix `igr`)"""
id: IntegrationID!
): Integration @topic(names: ["integrations"])
"""
List integrations, one row each. Drill into versions with listIntegrationDefinitions. Requires integration:list permission.
"""
listIntegrations(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Sort options"""
sort: [IntegrationSortInput!]
"""Filter options"""
filter: IntegrationFilterInput
): IntegrationConnection! @topic(names: ["integrations"])
"""Get a workflow trigger by ID. Requires workflow:read permission."""
workflowTrigger(
"""
TypeID (prefix `wft`) of the trigger to fetch. Returns null if no such trigger exists.
"""
id: WorkflowTriggerID!
): WorkflowTriggerState @topic(names: ["workflows"])
"""List all triggers for a workflow. Requires workflow:list permission."""
workflowTriggers(
"""
TypeID (prefix `wfl`) of the workflow whose triggers are listed. Results are scoped to the caller's tenant; enabled and disabled triggers are both returned.
"""
workflowId: WorkflowID!
): [WorkflowTriggerState!]! @topic(names: ["workflows"])
"""
List all triggers for the current tenant. Requires workflow:list permission.
"""
allWorkflowTriggers: [WorkflowTriggerState!]! @topic(names: ["workflows"])
"""
Fetch a single workflow execution by ID. Requires workflow:read permission.
"""
getExecution(
"""Execution ID to fetch"""
id: WorkflowExecutionID!
): WorkflowExecutionState @topic(names: ["workflows"]) @topic_example(names: ["prepress.read-execution"])
"""
List workflow executions with pagination. Requires workflow:list permission.
"""
listExecutions(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: WorkflowExecutionFilterInput
"""Sort order"""
sort: [WorkflowExecutionSortInput!]
): WorkflowExecutionConnection! @topic(names: ["workflows"])
"""
Fetch all steps for a workflow execution. Requires workflow:read permission.
"""
getExecutionSteps(
"""Execution ID to fetch steps for"""
executionId: WorkflowExecutionID!
): [WorkflowExecutionStepState!]! @topic(names: ["workflows"])
"""
Inspect the exact workflow runner authority and audited recovery revision. Requires workflow:read permission.
"""
workflowExecutionRuntimeManagement(
"""Execution ID to inspect"""
id: WorkflowExecutionID!
): WorkflowExecutionRuntimeManagementState @topic(names: ["workflows"])
"""
Aggregate a workflow's runs over a time window: totals by status, duration percentiles, time buckets and per-node outcomes. Requires workflow:list permission.
"""
workflowRunStats(
"""Workflow whose runs are aggregated"""
workflowId: WorkflowID!
"""Start of the window (inclusive), by run start time"""
since: ISO8601!
"""End of the window (exclusive); defaults to now"""
until: ISO8601
"""
Bucket size in minutes, clamped to 5–1440. A window needing more than 500 buckets is rejected.
"""
bucketMinutes: Int = 60
): WorkflowRunStats! @topic(names: ["workflows"])
"""
Run health of every workflow in the tenant that has a run since `since` or a run currently waiting: failures in the window, waiting runs and the latest run's status. Requires workflow:list permission.
"""
workflowRunHealth(
"""Failures count from this time (inclusive), by run start time"""
since: ISO8601!
): [WorkflowRunHealth!]! @topic(names: ["workflows"])
"""
Fetch a single dashboard card. Visibility follows the parent dashboard. Requires dashboard:read permission.
"""
getDashboardCard(
"""Card ID to fetch"""
cardId: DashboardCardID!
"""
Optional: the dashboard the card is on. A card ID is unique, so this is only a check; a card on another dashboard is not found.
"""
dashboardId: DashboardID
): DashboardCardState @topic(names: ["apps"])
"""
Fetch a dashboard by ID with its cards. Requires dashboard:read permission.
"""
getDashboard(
"""Dashboard ID to fetch"""
id: DashboardID!
): DashboardState @topic(names: ["apps"])
"""
List dashboards visible to the current user. Returns personal dashboards owned by the user and shared dashboards. Requires dashboard:list permission.
"""
listDashboards(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: DashboardFilterInput
"""Sort order"""
sort: [DashboardSortInput!]
): DashboardConnection! @topic(names: ["apps"])
"""Fetch a custom app by ID. Requires customapp:read permission."""
getCustomApp(
"""Custom app ID to fetch"""
id: CustomAppID!
): CustomAppState @topic(names: ["apps"])
"""Fetch a custom app by handle. Requires customapp:read permission."""
getCustomAppByHandle(
"""Custom app handle to fetch"""
handle: String!
): CustomAppState @topic(names: ["apps"])
"""
List custom apps with pagination and filtering. Requires customapp:list permission.
"""
listCustomApps(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: CustomAppFilterInput
"""Sort order"""
sort: [CustomAppSortInput!]
): CustomAppConnection! @topic(names: ["apps"])
"""List custom app user bindings. Requires customappuser:read permission."""
listCustomAppUsers(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: CustomAppUserFilterInput
): CustomAppUserConnection! @topic(names: ["apps"])
"""List custom app team bindings. Requires customappteam:read permission."""
listCustomAppTeams(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: CustomAppTeamFilterInput
): CustomAppTeamConnection! @topic(names: ["apps"])
"""Fetch a custom app version by ID. Requires customapp:read permission."""
getCustomAppVersion(
"""Version ID to fetch"""
id: CustomAppVersionID!
): CustomAppVersionState @topic(names: ["apps"])
"""List versions for a custom app. Requires customapp:read permission."""
listCustomAppVersions(
"""Custom app to list versions for"""
customAppId: CustomAppID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: CustomAppVersionFilterInput
"""Sort order"""
sort: CustomAppVersionSortInput
): CustomAppVersionConnection! @topic(names: ["apps"])
"""
The published journeys the caller may run or list, for menus and runners. Visible items are those the caller may read as a resource, plus their own PERSONAL items with no permission grant. The caller's own PERSONAL journeys are listed even when their required domains are out of reach, with access.usable false and no definition.
"""
journeyViews(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""Cursor from a previous page's `endCursor`."""
after: String
): JourneyViewConnection! @topic(names: ["surfaces"])
"""
One published journey by handle, as journeyViews would list it; null when unknown, unpublished or not visible to the caller.
"""
journeyView(
"""The journey's stable handle."""
handle: String!
"""
TypeID of a published version of this journey to serve instead of the current one (prefix `jnv`), so a run resumes on the version it started. Null is returned when it is a draft or belongs to another journey.
"""
versionId: JourneyVersionID
): JourneyView @topic(names: ["surfaces"])
"""
The published workspaces the caller may open or list, for menus and renderers. Visible items are those the caller may read as a resource, plus their own PERSONAL items with no permission grant. The caller's own PERSONAL workspaces are listed even when their required domains are out of reach, with access.usable false and no definition.
"""
workspaceViews(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""Cursor from a previous page's `endCursor`."""
after: String
): WorkspaceViewConnection! @topic(names: ["surfaces"])
"""
One published workspace by handle, as workspaceViews would list it; null when unknown, unpublished or not visible to the caller.
"""
workspaceView(
"""The workspace's stable handle."""
handle: String!
): WorkspaceView @topic(names: ["surfaces"])
"""
The published custom apps the caller may run. With customapp:list, every app visible to them; without it, the apps assigned to them directly or through one of their teams.
"""
customAppViews(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""Cursor from a previous page's `endCursor`."""
after: String
): CustomAppViewConnection! @topic(names: ["apps"])
"""
One published custom app by handle, as customAppViews would list it (customapp:read in place of customapp:list); null when unknown, unpublished or not visible to the caller.
"""
customAppView(
"""The custom app's handle."""
handle: String!
): CustomAppView @topic(names: ["apps"])
"""
Fetch a custom data container by ID. Requires customapp:read permission.
"""
getCustomDataContainer(
"""Container query input"""
input: CustomDataContainerByIdInput!
): CustomDataContainerState @topic(names: ["apps"])
"""
List containers for a custom app with pagination. Requires customapp:read permission.
"""
listCustomDataContainersByApp(
"""App filter input"""
input: CustomDataContainersByAppInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): CustomDataContainerConnection! @topic(names: ["apps"])
"""
List containers tagged to a specific entity with pagination. Requires customapp:read permission.
"""
listCustomDataContainersByTaggable(
"""Taggable filter input"""
input: CustomDataContainersByTaggableInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): CustomDataContainerConnection! @topic(names: ["apps"])
"""Fetch a data schema by ID. Requires dataschema:read permission."""
getDataSchema(
"""Schema query input"""
input: DataSchemaByIdInput!
): DataSchemaState @topic(names: ["apps"])
"""Fetch a data schema by name. Requires dataschema:read permission."""
getDataSchemaByName(
"""Schema query input by name"""
input: DataSchemaByNameInput!
): DataSchemaState @topic(names: ["apps"])
"""
List all data schemas for the current tenant with pagination. Requires dataschema:read permission.
"""
dataSchemas(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): DataSchemaConnection! @topic(names: ["apps"])
"""
List data schemas with pagination. Requires dataschema:list permission.
"""
listDataSchemas(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: DataSchemaFilterInput
"""Sort order"""
sort: [DataSchemaSortInput!]
): DataSchemaConnection! @topic(names: ["apps"])
"""Fetch a data record by ID. Requires datarecord:read permission."""
getDataRecord(
"""Record query input"""
input: DataRecordByIdInput!
): DataRecordState @topic(names: ["apps"])
"""
List data records for a schema with pagination. Requires datarecord:read permission.
"""
dataRecordsBySchema(
"""Schema filter input"""
input: DataRecordsBySchemaInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): DataRecordConnection! @topic(names: ["apps"])
"""
List data records with pagination. Requires datarecord:list permission.
"""
listDataRecords(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria (schemaId required)"""
filter: DataRecordFilterInput!
"""Sort order"""
sort: [DataRecordSortInput!]
): DataRecordConnection! @topic(names: ["apps"])
"""
List data records tagged to a specific entity with pagination. Requires datarecord:read permission.
"""
dataRecordsByTaggable(
"""Taggable filter input"""
input: DataRecordsByTaggableInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): DataRecordConnection! @topic(names: ["apps"])
"""
Fetch a protobuf schema by ID. Requires protobufSchema:read permission.
"""
getProtobufSchema(
"""Schema query input"""
input: ProtobufSchemaByIdInput!
): ProtobufSchemaState @topic(names: ["apps"])
"""
Fetch a protobuf schema by name. Requires protobufSchema:read permission.
"""
getProtobufSchemaByName(
"""Schema query input by name"""
input: ProtobufSchemaByNameInput!
): ProtobufSchemaState @topic(names: ["apps"])
"""
List protobuf schemas with pagination. Requires protobufSchema:list permission.
"""
listProtobufSchemas(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ProtobufSchemaFilterInput
"""Sort order"""
sort: [ProtobufSchemaSortInput!]
): ProtobufSchemaConnection! @topic(names: ["apps"])
"""Fetch a single network by ID. Requires network:read permission."""
getNetwork(
"""Network ID to fetch"""
id: NetworkID!
): NetworkState @topic(names: ["devices"])
"""List networks with pagination. Requires network:list permission."""
listNetworks(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for networks"""
filter: NetworkFilterInput
"""Sort order for results"""
sort: [NetworkSortInput!]
): NetworkConnection! @topic(names: ["devices"])
"""Fetch a single controller by ID. Requires controller:read permission."""
getController(
"""Controller ID to fetch"""
id: ControllerID!
): ControllerState @topic(names: ["devices"])
"""
Check whether a controller has an active bridge connection. Requires controller:read permission.
"""
controllerConnectionStatus(
"""Controller ID to check connection status for"""
id: ControllerID!
): BridgeConnectionStatus! @topic(names: ["devices"])
"""
Latest discovery and health snapshot, with platform receipt time and freshness
"""
controllerStatus(
"""Controller ID"""
id: ControllerID!
): ControllerStatusSnapshot! @topic(names: ["devices"])
"""List controllers with pagination. Requires controller:list permission."""
listControllers(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for controllers"""
filter: ControllerFilterInput
"""Sort order for results"""
sort: [ControllerSortInput!]
): ControllerConnection! @topic(names: ["devices"])
"""
List controller tokens with pagination. Requires controller_token:list permission.
"""
listControllerTokens(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for controller tokens"""
filter: ControllerTokenFilterInput
"""Sort order for results"""
sort: [ControllerTokenSortInput!]
): ControllerTokenConnection! @topic(names: ["devices"])
"""
Validate complete EdgeApp XML without saving; returns compiler catalog and original source ranges.
"""
analyzeEdgeAppSource(
"""
Complete author-owned EdgeApp XML to analyze without saving or publishing it.
"""
sourceXML: String!
): JSON! @topic(names: ["devices"])
"""Fetch a edge app by ID. Requires edge_app:read permission."""
getEdgeApp(
"""Edge app ID"""
id: EdgeAppID!
): EdgeAppState @topic(names: ["devices"])
"""List edge apps with pagination. Requires edge_app:list permission."""
listEdgeApps(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria"""
filter: EdgeAppFilterInput
"""Sort order for results"""
sort: [EdgeAppSortInput!]
): EdgeAppConnection! @topic(names: ["devices"])
"""
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.
"""
validateEdgeAppSource(
"""EdgeApp scripts to type-check"""
input: ValidateEdgeAppSourceInput!
): ValidateEdgeAppSourceResult! @topic(names: ["devices"])
"""
Read exact EdgeApp XML for authoring. Requires edge_app:write permission.
"""
getEdgeAppSource(
"""EdgeApp version whose authoring source to read"""
id: EdgeAppID!
): EdgeAppSourceView @topic(names: ["devices"])
"""
Fetch a edge app installation by ID. Requires edge_app_installation:read permission.
"""
getEdgeAppInstallation(
"""EdgeApp installation ID"""
id: EdgeAppInstallationID!
): EdgeAppInstallationState @topic(names: ["devices"])
"""
List edge app installations with pagination. Requires edge_app_installation:list permission.
"""
listEdgeAppInstallations(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria"""
filter: EdgeAppInstallationFilterInput
"""Sort order for results"""
sort: [EdgeAppInstallationSortInput!]
): EdgeAppInstallationConnection! @topic(names: ["devices"])
"""Fetch a edge app event by ID. Requires edge_app_event:read permission."""
getEdgeAppEvent(
"""Edge app event ID"""
id: EdgeAppEventID!
): EdgeAppEventState @topic(names: ["devices"])
"""
List edge app events with pagination. Requires edge_app_event:list permission.
"""
listEdgeAppEvents(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria"""
filter: EdgeAppEventFilterInput
"""Sort order for results"""
sort: [EdgeAppEventSortInput!]
): EdgeAppEventConnection! @topic(names: ["devices"])
"""
Fetch a controller policy by its ID. Requires controller_policy:read permission.
"""
getControllerPolicy(
"""Controller policy ID"""
id: ControllerPolicyID!
): ControllerPolicyState @topic(names: ["devices"])
"""
Fetch a controller's policy by the controller ID (the natural key). Returns null if no policy is configured (default-deny).
"""
getControllerPolicyByController(
"""Controller to look up"""
controllerId: ControllerID!
): ControllerPolicyState @topic(names: ["devices"])
"""
List controller policies with pagination. Requires controller_policy:list permission.
"""
listControllerPolicies(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria"""
filter: ControllerPolicyFilterInput
"""Sort order for results"""
sort: [ControllerPolicySortInput!]
): ControllerPolicyConnection! @topic(names: ["devices"])
"""Fetch a single device by ID. Requires device:read permission."""
getDevice(
"""Device ID to fetch"""
id: DeviceID!
): DeviceState @topic(names: ["devices"])
"""List devices with pagination. Requires device:list permission."""
listDevices(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for devices"""
filter: DeviceFilterInput
"""Sort order for results"""
sort: [DeviceSortInput!]
): DeviceConnection! @topic(names: ["devices"])
"""
List device tokens with pagination. Requires device_token:list permission.
"""
listDeviceTokens(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for device tokens"""
filter: DeviceTokenFilterInput
"""Sort order for results"""
sort: [DeviceTokenSortInput!]
): DeviceTokenConnection! @topic(names: ["devices"])
"""
Fetch an API token by ID (user can only see their own tokens). Requires apitoken:read permission.
"""
getAPIToken(
"""API token ID to fetch"""
id: APITokenID!
): APITokenState @topic(names: ["admin"])
"""
List the current user's API tokens with pagination. Requires apitoken:list permission.
"""
listMyAPITokens(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: APITokenFilterInput
"""Sort order"""
sort: [APITokenSortInput!]
): APITokenConnection! @topic(names: ["admin"])
"""
List the API tokens belonging to a bot user. Returns an empty list if the target user is not a bot. Requires apitoken:list permission.
"""
listBotAPITokens(
"""Bot user whose tokens to list"""
userId: UserID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: APITokenFilterInput
"""Sort order"""
sort: [APITokenSortInput!]
): APITokenConnection! @topic(names: ["admin"])
"""Fetch an AI adapter by ID. Requires aiadapter:read permission."""
getAIAdapter(
"""AI adapter ID to fetch"""
id: AIAdapterID!
): AIAdapterOutput @topic(names: ["aiml"])
"""
List AI adapters with pagination and filtering. Requires aiadapter:list permission.
"""
listAIAdapters(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: AIAdapterFilterInput
"""Sort order"""
sort: [AIAdapterSortInput!]
): AIAdapterConnection! @topic(names: ["aiml"])
"""Fetch an AI agent by ID. Requires aiAgent:read permission."""
getAIAgent(
"""AI agent ID to fetch"""
id: AIAgentID!
): AIAgentState @topic(names: ["aiml"])
"""List AI agents with pagination. Requires aiAgent:list permission."""
listAIAgents(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: AIAgentFilterInput
"""Sort order"""
sort: [AIAgentSortInput!]
): AIAgentConnection! @topic(names: ["aiml"])
"""
Check ml-model XML without saving it: returns { valid, diagnostics: [{ path, message, severity, sourceRange }], elements }, where elements is the compiler's vocabulary for editor completion. Requires mlmodelconfig:read permission.
"""
analyzeMLModelSource(
"""Complete ml-model XML to check without saving it anywhere."""
sourceXML: String!
): JSON! @topic(names: ["aiml"])
"""
Fetch an ML model config by ID. Requires mlmodelconfig:read permission.
"""
getMLModelConfig(
"""ML model config ID to fetch"""
id: MLModelConfigID!
): MLModelConfigOutput @topic(names: ["aiml"])
"""
List ML model configs with pagination and filtering. Requires mlmodelconfig:list permission.
"""
listMLModelConfigs(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: MLModelConfigFilterInput
"""Sort order"""
sort: [MLModelConfigSortInput!]
): MLModelConfigConnection! @topic(names: ["aiml"])
"""
Export an ML model config as JSON or YAML. Requires mlmodelconfig:read permission.
"""
exportMLModelConfig(
"""Export input (ID and format)"""
input: ExportMLModelConfigInput!
): ExportMLModelConfigPayload! @topic(names: ["aiml"])
"""
List versions for an ML model config, newest first, with pagination. Requires mlmodelconfig:read permission.
"""
listMLModelConfigVersions(
"""ML model config ID to list versions for"""
configId: MLModelConfigID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): MLModelConfigVersionConnection! @topic(names: ["aiml"])
"""
Get the most recently trained version of an ML model config, published or not, with its holdout evaluation; null before the first successful training run. Requires mlmodelconfig:read permission.
"""
latestMLModelConfigVersion(
"""ML model config ID to get the latest version of"""
configId: MLModelConfigID!
): MLModelConfigVersionOutput @topic(names: ["aiml"])
"""
Get a specific ML model config version by ID. Requires mlmodelconfig:read permission.
"""
getMLModelConfigVersion(
"""Version ID to fetch"""
id: MLModelConfigVersionID!
): MLModelConfigVersionOutput @topic(names: ["aiml"])
"""
Your ML experiments, most recently active first, ordered as stored when each page is read: an experiment opened while you page moves to the front and may be skipped or repeated. Requires mlmodelconfig:execute permission and a signed-in user.
"""
myMLExperiments(
"""Number of experiments from the most recently active"""
first: Int
"""Cursor to continue after"""
after: String
): MLExperimentConnection! @topic(names: ["aiml"])
"""
Open one of your ML experiments, which marks it active; null when you have no such experiment. Requires mlmodelconfig:execute permission and a signed-in user.
"""
mlExperiment(
"""ID of one of your experiments"""
id: MLExperimentID!
): MLExperiment @topic(names: ["aiml"])
"""
Fetch one of your chat sessions by ID. Your own OPS sessions need only a login; any other session requires chatsession:read permission.
"""
getChatSession(
"""Chat session ID to fetch"""
id: ChatSessionID!
): ChatSessionState @topic(names: ["aiml"])
"""
List your chat sessions with pagination and filtering. Listing only OPS sessions (filter context eq OPS) needs only a login; any other listing requires chatsession:list permission.
"""
listChatSessions(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: ChatSessionFilterInput
"""Sort order"""
sort: ChatSessionSortInput
): ChatSessionConnection! @topic(names: ["aiml"])
"""
Report configured adapter eligibility for this tenant. This is not a live provider health check; use testAIAdapter to verify credentials and model access. ops needs only a login; the adapter ids require chatsession:read permission and are null without it.
"""
chatAIAvailability: ChatAIAvailability! @topic(names: ["aiml"])
"""
Complete bounded lifecycle/deletion feed. A reset cursor is captured before full reconciliation; persist only with corresponding observations.
"""
integrationDefinitionChanges(
"""
Opaque cursor returned by the previous read of this feed; omit it to start from a reset cursor. An expired, foreign or otherwise unusable cursor yields a reset rather than an error.
"""
cursor: String
): JSON! @topic(names: ["integrations"])
"""
Observe live lifecycle and revision without loading definition content. Requires integrationDefinition:read permission.
"""
getIntegrationDefinitionObservation(
"""Integration definition ID to observe"""
id: IntegrationDefinitionID!
): IntegrationDefinitionObservation @topic(names: ["integrations"])
"""
Fetch a single integration definition by ID. Requires integrationDefinition:read permission.
"""
getIntegrationDefinition(
"""Integration definition ID to fetch"""
id: IntegrationDefinitionID!
): IntegrationDefinitionState @topic(names: ["integrations"])
"""
List integration definitions with pagination, sorting, and filtering. Requires integrationDefinition:list permission.
"""
listIntegrationDefinitions(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Sort order"""
sort: [IntegrationDefinitionSortInput!]
"""Filter criteria"""
filter: IntegrationDefinitionFilterInput
): IntegrationDefinitionConnection! @topic(names: ["integrations"])
"""
Compiler-owned XML v1 vocabulary and delegated Workflow/EdgeApp catalogs; definition authoring only.
"""
integrationAuthoringCatalog: JSON! @topic(names: ["integrations"])
"""
Inspect up to 100 retained cleanup sessions, newest first, including operator reconciliation evidence. Works after desired configuration deletion.
"""
integrationRuntimeRetirements(
"""
Integration installation whose retired sessions to list, including a deleted one.
"""
id: IntegrationInstanceID!
): [IntegrationRuntimeRetirementState!]! @topic(names: ["integrations"])
"""
Read exact runtime identities and management revision before an operator recovery action.
"""
integrationRuntimeManagement(
"""Integration installation to inspect."""
id: IntegrationInstanceID!
): IntegrationRuntimeManagementState @topic(names: ["integrations"])
"""
Fetch a single integration instance by ID. Requires integrationInstance:read permission.
"""
getIntegrationInstance(
"""Integration instance ID to fetch"""
id: IntegrationInstanceID!
): IntegrationInstanceState @topic(names: ["integrations"])
"""
List the timers declared in the native v3 definition backing this instance. Requires integrationInstance:read permission.
"""
integrationInstanceTimers(
"""Integration instance ID whose declared timers should be listed"""
instanceId: IntegrationInstanceID!
): [IntegrationInstanceTimer!]! @topic(names: ["integrations"])
"""
List integration instances with pagination, sorting, and filtering. Requires integrationInstance:list permission.
"""
listIntegrationInstances(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Sort order"""
sort: [IntegrationInstanceSortInput!]
"""Filter criteria"""
filter: IntegrationInstanceFilterInput
): IntegrationInstanceConnection! @topic(names: ["integrations"])
"""
Fetch an integration data container by ID. Requires integrationDataContainer:read permission.
"""
getIntegrationDataContainer(
"""Container query input"""
input: IntegrationDataContainerByIdInput!
): IntegrationDataContainerState @topic(names: ["integrations"])
"""
Fetch an integration data container by instance, schema, and name. Requires integrationDataContainer:read permission.
"""
getIntegrationDataContainerByName(
"""Container lookup input"""
input: IntegrationDataContainerByNameInput!
): IntegrationDataContainerState @topic(names: ["integrations"])
"""
List containers for an integration instance with pagination. Requires integrationDataContainer:list permission.
"""
listIntegrationDataContainersByInstance(
"""Instance filter input"""
input: IntegrationDataContainersByInstanceInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): IntegrationDataContainerConnection! @topic(names: ["integrations"])
"""
List containers tagged to a specific entity with pagination. Requires integrationDataContainer:list permission.
"""
listIntegrationDataContainersByTaggable(
"""Taggable filter input"""
input: IntegrationDataContainersByTaggableInput!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): IntegrationDataContainerConnection! @topic(names: ["integrations"])
"""
Fetch a single custom action by id within the caller's tenant. Returns null when no such action exists. Requires customWorkflowAction:read permission.
"""
getCustomWorkflowAction(
"""TypeID (prefix `cac`) of the custom action to fetch."""
id: CustomWorkflowActionID!
): CustomWorkflowActionState @topic(names: ["scripting"])
"""
List the caller's tenant's custom actions, filtered and sorted. Requires customWorkflowAction:list permission.
"""
listCustomWorkflowActions(
"""
Forward page size: maximum number of actions to return after the after cursor. Defaults to 25 and may not exceed 100.
"""
first: Int
"""
Cursor to page after, as returned in pageInfo.endCursor. Only actions positioned after it in the requested sort order are returned.
"""
after: String
"""
Restrict the listing by name, label, or active state. Omit to list all.
"""
filter: CustomWorkflowActionFilterInput
"""
Ordering clauses; only the first clause is applied, and both its field and direction are honoured. Defaults to createdAt descending.
"""
sort: [CustomWorkflowActionSortInput!]
): CustomWorkflowActionConnection! @topic(names: ["scripting"])
"""
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.
"""
listAvailableActions(
"""
Forward page size: maximum number of actions to return after the after cursor. Defaults to 25 and may not exceed 100.
"""
first: Int
"""
Cursor to page after, as returned in pageInfo.endCursor. Only actions positioned after it in label order are returned.
"""
after: String
): AvailableActionConnection! @topic(names: ["scripting"])
"""
Fetch a notification group by ID. Requires notificationGroup:read permission.
"""
getNotificationGroup(
"""Notification group ID to fetch"""
id: NotificationGroupID!
): NotificationGroupState @topic(names: ["integrations"])
"""
List notification groups with pagination. Requires notificationGroup:list permission.
"""
listNotificationGroups(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: NotificationGroupFilterInput
"""Sort order"""
sort: [NotificationGroupSortInput!]
): NotificationGroupConnection! @topic(names: ["integrations"])
"""
Fetch a notification recipient by ID. Requires notificationRecipient:read permission.
"""
getNotificationRecipient(
"""Notification recipient ID to fetch"""
id: NotificationRecipientID!
): NotificationRecipientState @topic(names: ["integrations"])
"""
List notification recipients with pagination. Requires notificationRecipient:list permission.
"""
listNotificationRecipients(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: NotificationRecipientFilterInput
"""Sort order"""
sort: [NotificationRecipientSortInput!]
): NotificationRecipientConnection! @topic(names: ["integrations"])
"""
Fetch an incoming webhook by ID. Requires incomingWebhook:read permission.
"""
getIncomingWebhook(
"""Webhook ID to fetch"""
id: IncomingWebhookID!
): IncomingWebhookState @topic(names: ["integrations"])
"""
List incoming webhooks with pagination and filtering. Requires incomingWebhook:list permission.
"""
listIncomingWebhooks(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: IncomingWebhookFilterInput
"""Sort order"""
sort: [IncomingWebhookSortInput!]
): IncomingWebhookConnection! @topic(names: ["integrations"])
"""
List endpoint logs with pagination. Requires incomingWebhook:read permission.
"""
listEndpointLogs(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: EndpointLogFilterInput
"""Sort order"""
sort: [EndpointLogSortInput!]
): EndpointLogConnection! @topic(names: ["admin"])
"""
Get aggregate statistics for an incoming webhook endpoint. Requires incomingWebhook:read permission.
"""
getIncomingWebhookStats(
"""Webhook endpoint ID to get stats for"""
endpointId: IncomingWebhookID!
): IncomingWebhookStats! @topic(names: ["admin"])
"""List execution log entries for a given context, newest first"""
listExecutionLogs(
"""Type of execution context"""
contextType: ExecutionLogContextType!
"""ID of the execution context (e.g., integration instance ID)"""
contextId: String!
"""Filter by log level"""
level: ExecutionLogLevel
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ExecutionLogConnection! @topic(names: ["workflows"])
"""
Query logs across all drains (webhook, execution, edge app, archive). Requires log:list permission.
"""
queryLogs(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria"""
filter: UnifiedLogFilterInput
"""Sort order for results"""
sort: [UnifiedLogSortInput!]
): UnifiedLogConnection! @topic(names: ["admin"])
"""Fetch a single metric by ID. Requires metric:read permission."""
getMetric(
"""Metric ID to fetch"""
id: MetricID!
): MetricState @topic(names: ["devices"])
"""List metrics with pagination. Requires metric:list permission."""
listMetrics(
"""Number of items to return from the start"""
first: Int
"""Number of items to return from the end"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for metrics"""
filter: MetricFilterInput
"""Sort order for results"""
sort: [MetricSortInput!]
): MetricConnection! @topic(names: ["devices"])
"""
Query time-series data points for a metric. Returns a flat array ordered by timestamp, with summary stats. Requires metric:read permission.
"""
getMetricPoints(
"""Metric ID to query points for"""
metricId: MetricID!
"""Start of time range (ISO8601)"""
from: ISO8601
"""End of time range (ISO8601)"""
to: ISO8601
"""Maximum number of points to return (default 1000)"""
limit: Int
): MetricPointsResult! @topic(names: ["devices"])
"""
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.
"""
aggregateMetricPoints(
"""Aggregation parameters"""
input: AggregateMetricPointsInput!
): MetricAggregatePointsResult! @topic(names: ["devices"])
"""
Compute a value distribution histogram for a metric over a time range. Range bounds are auto-detected if not specified. Requires metric:read permission.
"""
metricHistogram(
"""Histogram parameters"""
input: MetricHistogramInput!
): MetricHistogramResult! @topic(names: ["devices"])
"""
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.
"""
metricPercentiles(
"""Percentile parameters"""
input: MetricPercentilesInput!
): MetricPercentilesResult! @topic(names: ["devices"])
"""
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.
"""
metricProjection(
"""Projection parameters"""
input: MetricProjectionInput!
): MetricProjectionResult! @topic(names: ["devices"])
"""
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.
"""
compareMetrics(
"""Comparison parameters"""
input: CompareMetricsInput!
): MetricComparisonResult! @topic(names: ["devices"])
"""
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.
"""
metricStateDuration(
"""State duration parameters"""
input: MetricStateDurationInput!
): MetricStateDurationResult! @topic(names: ["devices"])
"""
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.
"""
metricHeartbeat(
"""Heartbeat parameters"""
input: MetricHeartbeatInput!
): MetricHeartbeatResult! @topic(names: ["devices"])
"""
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.
"""
downsampleMetricPoints(
"""Downsample parameters"""
input: MetricDownsampleInput!
): MetricDownsampleResult! @topic(names: ["devices"])
"""
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.
"""
metricCorrelation(
"""Correlation parameters"""
input: MetricCorrelationInput!
): MetricCorrelationResult! @topic(names: ["devices"])
"""
Query progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.
"""
queryProgressPoints(
"""Filter criteria"""
filter: ProgressPointFilterInput
"""
Forward page size: maximum number of points to return after the after cursor. Defaults to 25 and may not exceed 100.
"""
first: Int
"""
Cursor to page after, as returned in pageInfo.endCursor. Points are ordered newest first, so this returns points strictly older than the cursor. Because the underlying time-series table has no per-row id, points sharing the exact same timestamp may straddle a page boundary.
"""
after: String
): ProgressPointConnection! @topic(names: ["workflows"])
"""
Get the most recent progress snapshot for an operation. Requires progressPoint:read permission.
"""
latestProgress(
"""Operation ID to get the latest progress for"""
operationId: OperationID!
): ProgressPointState @topic(names: ["workflows"])
"""List status transition events for a work center"""
listWorkCenterStatusEvents(
"""
TypeID (`wcr_` prefix) of the work centre whose history to read (required). Results are additionally scoped to the caller's tenant.
"""
workCenterId: WorkCenterID!
"""
Inclusive lower bound on the event timestamp (ISO8601). Omit for no lower bound.
"""
from: ISO8601
"""
Inclusive upper bound on the event timestamp (ISO8601). Omit for no upper bound.
"""
to: ISO8601
"""
Include voided and superseded originals for audit history (default true). False excludes them before limiting; use to for a current-time cutoff.
"""
includeCorrected: Boolean
"""
Maximum number of events to return, newest first. Defaults to 50 and is capped at 200.
"""
limit: Int
): WorkCenterStatusEventConnection! @topic(names: ["jobs"])
"""
Fetch an operation completion record by ID. Requires operation:read permission.
"""
getOperationCompletion(
"""Operation completion ID to fetch"""
id: OperationCompletionID!
): OperationCompletionState @topic(names: ["jobs"])
"""
Fetch the most recent completion record for an operation. Requires operation:read permission.
"""
getOperationCompletionByOperation(
"""Operation ID to find completion for"""
operationId: OperationID!
): OperationCompletionState @topic(names: ["jobs"]) @topic_example(names: ["production.read-completion"])
"""
List operation completion records with pagination. Requires operation:list permission.
"""
listOperationCompletions(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: OperationCompletionFilterInput
"""Sort order"""
sort: [OperationCompletionSortInput!]
): OperationCompletionConnection! @topic(names: ["jobs"])
"""Fetch a production report by ID. Requires productionReport:read."""
getProductionReport(
"""
TypeID of the report to fetch (`prr_…`). Resolves to null when no report with that id exists in the caller's tenant.
"""
id: ProductionReportID!
): ProductionReportState @topic(names: ["jobs"])
"""
List production reports for the tenant, paginated. Requires productionReport:list.
"""
listProductionReports(
"""
Narrows the result set by binding refs, source integration, capability, or unbound-only. Omit to list every report in the tenant.
"""
filter: ProductionReportFilterInput
"""
Orders the result set by the chosen timestamp and direction. Omit to order by creation time, newest first.
"""
sort: ProductionReportSortInput
"""
Maximum number of reports to return. Defaults to 25 and is clamped to a hard cap of 100.
"""
first: Int
"""Cursor to start after"""
after: String
): ProductionReportConnection! @topic(names: ["jobs"])
"""
Derive accepted output quantities after corrections without inventory reads. Use these quantities instead of summing unadjusted receipts.
"""
productionOutputBalance(
"""
Original accepted report whose corrections and effective output quantities to return.
"""
reportId: ProductionReportID!
): ProductionOutputBalance! @topic(names: ["jobs"])
"""
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
"""
iacSchema: IaCSchemaDocument! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
"""
iacValidate(
"""Name of the validator to run, as declared by @iac_validator"""
validator: String!
"""Artifact source to validate"""
source: String!
"""
Script role whose API surface a lua-typecheck source is checked against: NORMAL, INTEGRATION, PURE or EDGE_APP. Defaults to NORMAL.
"""
role: String
): IaCValidationResult! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
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.
"""
iacGuides: [IaCGuide!]! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""List human-facing manual chapters from the running deployment."""
helpChapters: [HelpChapterInfo!]! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""Read a chapter of the current published manual edition."""
helpChapter(
"""Manual family from helpChapters."""
family: String!
"""Chapter slug from helpChapters."""
slug: String!
): HelpChapter @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""Search human-facing manuals using shared semantic and text retrieval."""
searchHelp(
"""Natural-language question or XML identifier; 1–500 characters."""
query: String!
"""Restrict to this manual family; omit to search all manuals."""
family: String
): HelpSearchResult! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
"""
schemaAuthoringCatalog: JSON! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
"""
compileSchemaXML(
"""Standalone schema XML, at most 256 KiB, in urn:cococo:json-schema:1."""
sourceXML: String!
): String! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
"""
renderSchemaXML(
"""JSON Schema to convert to native XML; at most 256 KiB."""
schemaJSON: String!
): String! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
"""
iacSchemaDocument(
"""
Document reference named by @iac_validator(schemaRef:) or @iac_artifact(testContract:), a shared-resource type such as CUSTOM_APP, or 'envelope'.
"""
ref: String!
): IaCSchemaDocumentPayload! @topic(names: [
"jobs"
"commerce"
"logistics"
"costing"
"productTemplates"
"files"
"devices"
"aiml"
"apps"
"workflows"
"admin"
"integrations"
"surfaces"
"scripting"
"reporting"
"reports"
"iam"
])
"""
Read a team membership by its own identity. Requires team:read permission.
"""
getTeamMembership(
"""Membership identity"""
id: TeamMembershipID!
): TeamMembershipState @topic(names: ["admin", "iam"])
"""
Find a team by its unique name in the authenticated tenant. Requires team:read permission.
"""
getTeamBy(
"""Exact unique team name"""
name: String!
): TeamState @topic(names: ["admin", "iam"])
"""Fetch a team by ID. Requires team:read permission."""
getTeam(
"""Team ID to fetch"""
id: TeamID!
): TeamState @topic(names: ["admin", "iam"])
"""List teams with pagination. Requires team:list permission."""
listTeams(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: TeamFilterInput
"""Sort order"""
sort: [TeamSortInput!]
): TeamConnection! @topic(names: ["admin", "iam"])
"""Teams an account belongs to. Requires team:read permission."""
teamsForUser(
"""Account to list team membership for"""
userId: UserID!
): [TeamState!]! @topic(names: ["admin", "iam"])
"""Fetch members of a team. Requires team:read permission."""
getTeamMembers(
"""Team ID to fetch members for"""
teamId: TeamID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): TeamMemberConnection! @topic(names: ["admin", "iam"])
"""
Fetch a task definition by ID. Requires taskDefinition:read permission.
"""
getTaskDefinition(
"""Task definition ID to fetch"""
id: TaskDefinitionID!
): TaskDefinitionState @topic(names: ["admin"])
"""
List task definitions with pagination. Requires taskDefinition:list permission.
"""
listTaskDefinitions(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: TaskDefinitionFilterInput
"""Sort order"""
sort: [TaskDefinitionSortInput!]
): TaskDefinitionConnection! @topic(names: ["admin"])
"""
Fetch a task by ID. Requires task:read permission, except for one's own task (assigned to or claimed by the caller, or unclaimed on one of their teams), which any signed-in user can read.
"""
getTask(
"""Task ID to fetch"""
id: TaskID!
): TaskState @topic(names: ["jobs"])
"""List all tasks with pagination. Requires task:list permission."""
listTasks(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: TaskFilterInput
"""Sort order"""
sort: [TaskSortInput!]
): TaskConnection! @topic(names: ["jobs"])
"""
List the caller's own tasks: assigned to or claimed by them, or unclaimed on one of their teams. Any signed-in user; no permission needed.
"""
myTasks(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria; bucket narrows to MINE or TEAM"""
filter: TaskFilterInput
"""Sort order"""
sort: [TaskSortInput!]
): TaskConnection! @topic(names: ["jobs"])
"""
Count the caller's open tasks by bucket, overdue and personal. Any signed-in user; no permission needed.
"""
myTaskCounts: MyTaskCounts! @topic(names: ["jobs"])
"""
Fetch the audit trail for a task, paginated. Requires task:read permission.
"""
getTaskEvents(
"""Task ID to fetch events for"""
taskId: TaskID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): TaskEventConnection! @topic(names: ["jobs"])
"""
The caller's running timer, on any task, or null. Any signed-in user; no permission needed: the timer is their own.
"""
myRunningTimer: TaskTimeEntry @topic(names: ["jobs"])
"""
The caller's own time entries on any task, newest first, voided ones included. Readable even once the task is no longer theirs to read. Any signed-in user; no permission needed: the entries are their own.
"""
myTimeEntries(
"""Number of entries from the newest"""
first: Int
"""Cursor to start after"""
after: String
"""Only entries whose work started at or after this instant (ISO8601)"""
from: ISO8601
"""Only entries whose work started before this instant (ISO8601)"""
to: ISO8601
): TaskTimeEntryConnection! @topic(names: ["jobs"])
"""
Browse the shared-resource catalog served by ControlApp, with optional type, text and category filters. Requires sharedResource:list permission.
"""
sharedResources(
"""
Restrict results to templates that install this kind of resource. Omit for all kinds.
"""
resourceType: SharedResourceType
"""
Free-text query matched by the catalog against template name, description and tags. Omit for no text filter.
"""
search: String
"""
Restrict results to templates filed under this catalog category. Omit for all categories.
"""
category: String
"""1-based page number to return. Defaults to 1."""
page: Int
"""Number of templates per page. Defaults to 20."""
perPage: Int
): SharedResourceConnection! @topic(names: ["apps"])
"""
Fetch a single catalog template's metadata by id. Returns null when no such template exists in the catalog. Requires sharedResource:read permission.
"""
getSharedResource(
"""TypeID of the catalog template to fetch ("srt_01K…")."""
id: SharedResourceTemplateID!
): SharedResourceEnvelope @topic(names: ["apps"])
"""
Every catalog template this tenant has installed, with the version installed — the basis for detecting available upgrades. Requires sharedResource:list permission.
"""
sharedResourceInstallations: [SharedResourceInstallationState!]! @topic(names: ["apps"])
"""
Fetch a single capability by id, scoped to the caller's tenant. Null when no visible capability has that id. Requires capability:read permission.
"""
getCapability(
"""TypeID (prefix "cpb") of the capability to fetch."""
id: CapabilityID!
): CapabilityState @topic(names: ["jobs"])
"""
Read an existing capability reference by identity. Returns null if not visible. Requires capability:read.
"""
getExistingCapability(
"""Identity of a capability visible to the caller."""
id: CapabilityID!
): ExistingCapability @topic(names: ["jobs"])
"""
Resolve an existing capability by code. A tenant-owned definition takes precedence over a shared definition, matching inference. Ambiguous definitions fail; missing codes return null. Read-only; requires capability:read.
"""
getCapabilityByCode(
"""Exact, case-sensitive capability code."""
code: String!
): ExistingCapability @topic(names: ["jobs"])
"""
List the capabilities visible to the caller's tenant — the tenant's own capabilities plus any non-tenant-scoped ones. Requires capability:list permission.
"""
listCapabilities(
"""
Forward page size: maximum edges to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
"""
first: Int
"""
Backward page size: maximum edges to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
"""
last: Int
"""
Opaque cursor from a previous edge; pages forward from just after it in the requested sort order. Cannot be combined with before.
"""
after: String
"""
Opaque cursor from a previous edge; pages backward from just before it in the requested sort order. Cannot be combined with after.
"""
before: String
"""
Predicates narrowing the result set. Omit to list every visible capability.
"""
filter: CapabilityFilterInput
"""
Ordering terms. Only the first term is applied, and both its field and direction are honoured. Defaults to createdAt descending.
"""
sort: [CapabilitySortInput!]
): CapabilityConnection! @topic(names: ["jobs"])
"""
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.
"""
getShiftDefinition(
"""TypeID (prefix "shd") of the shift definition to fetch."""
id: ShiftDefinitionID!
): ShiftDefinitionState @topic(names: ["jobs"])
"""
List the current tenant's shift definitions as a connection. Requires shiftDefinition:list permission.
"""
listShiftDefinitions(
"""
Forward pagination: how many shift definitions to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
"""
first: Int
"""
Backward pagination: how many shift definitions to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
"""
last: Int
"""
Forward pagination: return only definitions following this edge cursor in the requested sort order. Cannot be combined with before.
"""
after: String
"""
Backward pagination: return only definitions preceding this edge cursor in the requested sort order. Cannot be combined with after.
"""
before: String
"""
Narrow the result by name and/or creation time. Omit to list every definition in the tenant.
"""
filter: ShiftDefinitionFilterInput
"""
Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to createdAt descending (newest first) when omitted.
"""
sort: [ShiftDefinitionSortInput!]
): ShiftDefinitionConnection! @topic(names: ["jobs"])
"""
Fetch a single work center by id, scoped to the caller's tenant. Null when no such work center exists. Requires workCenter:read permission.
"""
getWorkCenter(
"""TypeID (prefix "wcr") of the work center to fetch."""
id: WorkCenterID!
): WorkCenterState @topic(names: ["jobs"])
"""
Fetch a work center by external ID. Requires workCenter:read permission.
"""
getWorkCenterBy(
"""External system identifier"""
externalId: String
): WorkCenterState @topic(names: ["jobs"])
"""
List the tenant's work centers as a paginated connection, with optional filtering and sorting. Requires workCenter:list permission.
"""
listWorkCenters(
"""Return the first N work centers after the cursor (forward pagination)."""
first: Int
"""
Return the last N work centers before the cursor (backward pagination).
"""
last: Int
"""Opaque cursor from a previous page's edge; results start after it."""
after: String
"""Opaque cursor from a previous page's edge; results end before it."""
before: String
"""
Criteria narrowing which work centers are returned; omit for all of them.
"""
filter: WorkCenterFilterInput
"""
Ordering terms. The first term's direction drives keyset pagination (defaults to newest-created first); any further terms are secondary sorts.
"""
sort: [WorkCenterSortInput!]
): WorkCenterConnection! @topic(names: ["jobs"])
"""
Read production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.
"""
productionSnapshot(
"""Opaque inventory cursor"""
after: String
"""Page size from 1 to 100, default 100"""
first: Int
"""Shared effective cutoff from the first page; cannot be in the future"""
asOf: ISO8601
): ProductionSnapshot! @topic(names: ["jobs", "workflows"])
"""
Status history, published plan and shifts for up to 100 active work centers of one cell over a window of at most 36 hours. Schedule and shift permissions are checked independently.
"""
productionDay(
"""Cell to read; null for work centers not assigned to a cell"""
productionCellId: ProductionCellID
"""Window start"""
from: ISO8601!
"""Window end; at most 36 hours after from"""
to: ISO8601!
): ProductionDay! @topic(names: ["jobs"])
"""
One capability assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
"""
getWorkCenterCapability(
"""TypeID of the capability assignment to fetch (prefix "wcc")."""
id: WorkCenterCapabilityID!
): WorkCenterCapabilityState @topic(names: ["jobs"])
"""
All capability assignments for one work center in the caller's tenant, returned in a single unpaginated page. Requires workCenter:read permission.
"""
listWorkCenterCapabilities(
"""
TypeID of the work center whose capabilities to list (prefix "wcr"). Required.
"""
workCenterId: WorkCenterID!
"""Optional narrowing of the work center's assignments by capability id."""
filter: WorkCenterCapabilityFilterInput
): WorkCenterCapabilityConnection! @topic(names: ["jobs"])
"""
One device binding by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
"""
getWorkCenterDevice(
"""TypeID of the device binding to fetch (prefix "wcd")."""
id: WorkCenterDeviceID!
): WorkCenterDeviceState @topic(names: ["jobs"])
"""
List the controller devices bound to a work center, preferred first. Requires workCenter:read.
"""
listWorkCenterDevices(
"""Work center whose device bindings to list (ordered by priority)"""
workCenterId: WorkCenterID!
): WorkCenterDeviceConnection! @topic(names: ["jobs"])
"""
One shift profile assignment by its own id, or null when it is not in the caller's tenant. Requires workCenter:read permission.
"""
getWorkCenterShiftProfile(
"""TypeID of the shift profile assignment to fetch (prefix "wsp")."""
id: WorkCenterShiftProfileID!
): WorkCenterShiftProfileState @topic(names: ["jobs"])
"""
Lists the shift profiles of one work center within the caller's tenant, ordered by validFrom ascending. Requires workCenter:read.
"""
listWorkCenterShiftProfiles(
"""
TypeID of the work center whose shift profiles to list (prefix "wcr"). Required — the query is always scoped to a single work center.
"""
workCenterId: WorkCenterID!
"""Optional additional filtering of the work center's shift profiles."""
filter: WorkCenterShiftProfileFilterInput
): WorkCenterShiftProfileConnection! @topic(names: ["jobs"])
"""
Fetch a single schedule scenario by id, or null when it does not exist. Requires scheduleScenario:read permission.
"""
getScheduleScenario(
"""TypeID of the schedule scenario to fetch (prefix "sch")."""
id: ScheduleScenarioID!
): ScheduleScenarioState @topic(names: ["jobs"])
"""
List the caller's tenant's schedule scenarios as a keyset-paginated connection. Requires scheduleScenario:list permission.
"""
listScheduleScenarios(
"""
Number of scenarios to take from the start of the page window (forward pagination).
"""
first: Int
"""
Number of scenarios to take from the end of the page window (backward pagination).
"""
last: Int
"""
Opaque cursor from a previous page; returns scenarios positioned after it.
"""
after: String
"""
Opaque cursor from a previous page; returns scenarios positioned before it.
"""
before: String
"""
Criteria narrowing which scenarios are returned. Omit to list all in the tenant.
"""
filter: ScheduleScenarioFilterInput
"""
Ordering terms. The first term's direction drives the createdAt keyset walk (DESC when omitted); further terms are applied as tie-breakers.
"""
sort: [ScheduleScenarioSortInput!]
): ScheduleScenarioConnection! @topic(names: ["jobs"])
"""
List the allocations of one schedule scenario, ordered by start time by default. Requires scheduleScenario:read permission.
"""
listScheduleAllocations(
"""
TypeID of the schedule scenario to list allocations from ("sch_01K…"). Required — allocations are never listed across scenarios.
"""
scheduleScenarioId: ScheduleScenarioID!
"""Optional filters narrowing the allocations within the scenario."""
filter: ScheduleAllocationFilterInput
"""
Ordering terms; only the first term is applied, and both its field and direction are honoured. Defaults to startAt descending.
"""
sort: [ScheduleAllocationSortInput!]
"""
Forward pagination page size: how many allocations to return after the after cursor. Defaults to 25, may not exceed 100, and cannot be combined with last.
"""
first: Int
"""
Backward pagination page size: how many allocations to return before the before cursor. Defaults to 25, may not exceed 100, and cannot be combined with first.
"""
last: Int
"""
Cursor to page forward from: only allocations following it in the requested sort order are returned. Cannot be combined with before.
"""
after: String
"""
Cursor to page backward from: only allocations preceding it in the requested sort order are returned. Cannot be combined with after.
"""
before: String
): ScheduleAllocationConnection! @topic(names: ["jobs"])
"""
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.
"""
listOperationEdges(
"""
Owning manufacturing form; select exactly one jobId or batchComponentId. Scope follows the successor.
"""
batchComponentId: BatchComponentID
"""TypeID (prefix `job`) of the job whose dependency edges to return."""
jobId: JobID
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): OperationEdgeConnection! @topic(names: ["jobs"])
"""
List operation items for an operation, sorted by sortOrder, with pagination. Requires operation:read permission.
"""
listOperationItems(
"""
TypeID (`opr_…`) of the operation whose items to list. Results are scoped to the calling tenant; an unknown id yields an empty list.
"""
operationId: OperationID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): OperationItemConnection! @topic(names: ["jobs"])
"""
List item-level dependency edges, with pagination. Filter by job and optionally by source/target operation. Requires operation:read permission.
"""
listOperationItemEdges(
"""
Owning manufacturing form; select exactly one jobId or batchComponentId. Scope follows the successor.
"""
batchComponentId: BatchComponentID
"""
TypeID of the job ("job_01K…") whose item edges to list. Alternatively select batchComponentId — edges are listed within one production scope.
"""
jobId: JobID
"""
Optional operation TypeID ("opr_01K…"); when given, only edges whose predecessor item belongs to that operation are returned.
"""
sourceOperationId: OperationID
"""
Optional operation TypeID ("opr_01K…"); when given, only edges whose successor item belongs to that operation are returned. Combine with sourceOperationId to fetch the edges of a single operation pair.
"""
targetOperationId: OperationID
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): OperationItemEdgeConnection! @topic(names: ["jobs"])
"""
Production plans of a job, newest version first, paginated. Plan headers only — no planned operations or edges. Requires productionPlan:read permission.
"""
listProductionPlans(
"""Form whose plans to list; exclusive with jobId."""
batchComponentId: BatchComponentID
"""TypeID of the job (`job_…`) whose plans to list."""
jobId: JobID
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ProductionPlanConnection! @topic(names: ["jobs"])
"""
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.
"""
getProductionPlan(
"""TypeID of the production plan (`ppl_…`) to fetch."""
id: ProductionPlanID!
): ProductionPlanWithChildren @topic(names: ["jobs"])
"""
Get an optimization run by ID. Requires optimizationRun:read permission.
"""
getOptimizationRun(
"""ID of the optimization run to retrieve"""
id: OptimizationRunID!
): OptimizationRunState @topic(names: ["jobs"])
"""
List optimization runs for a scenario, paginated. Requires optimizationRun:list permission.
"""
listOptimizationRuns(
"""Filter by schedule scenario"""
scenarioId: ScheduleScenarioID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): OptimizationRunConnection! @topic(names: ["jobs"])
"""
The latest behaviour profile version of a work centre, or null when none has been built. Requires workCenterBehaviorProfile:read permission.
"""
workCenterBehaviorProfile(
"""The work centre whose latest profile version to return"""
workCenterId: WorkCenterID!
): WorkCenterBehaviorProfile @topic(names: ["jobs"])
"""
Behaviour profile versions, paginated. Requires workCenterBehaviorProfile:list permission.
"""
workCenterBehaviorProfiles(
"""Optional filters"""
filter: WorkCenterBehaviorProfileFilterInput
"""Sort order; defaults to newest computed first"""
sort: [WorkCenterBehaviorProfileSortInput!]
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Number of items from the end"""
last: Int
"""Cursor to end before"""
before: String
): WorkCenterBehaviorProfileConnection! @topic(names: ["jobs"])
"""
The behaviour attributes the active vertical declares, highest priority first, so a custom app can render hypothetical inputs from the schema. Requires workCenterBehaviorProfile:read permission.
"""
twinBehaviorAttributes: [BehaviorAttributeDefinition!]! @topic(names: ["jobs"])
"""
A simulation run by id, or null when none exists. Requires scenarioSimulationRun:read permission.
"""
scenarioSimulationRun(
"""The run to fetch"""
id: ScenarioSimulationRunID!
): ScenarioSimulationRun @topic(names: ["jobs"])
"""
Simulation runs, paginated. Requires scenarioSimulationRun:list permission.
"""
scenarioSimulationRuns(
"""Optional filters"""
filter: ScenarioSimulationRunFilterInput
"""Sort order; defaults to newest created first"""
sort: [ScenarioSimulationRunSortInput!]
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Number of items from the end"""
last: Int
"""Cursor to end before"""
before: String
): ScenarioSimulationRunConnection! @topic(names: ["jobs"])
"""
Synchronous what-if over hypothetical work, optionally overlaid on a base scenario's allocations. Persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
"""
simulateWorkload(
"""Hypothetical work, optional base scenario and sampling options"""
input: SimulateWorkloadInput!
): SimulationResult! @topic(names: ["jobs"])
"""
The live shadow of one work centre, computed now. Requires workCenterBehaviorProfile:read permission.
"""
workCenterTwinShadow(
"""The work centre to shadow"""
workCenterId: WorkCenterID!
): WorkCenterTwinShadow! @topic(names: ["jobs"])
"""
Work centres with a live shadow, newest transition first, each entry judged now; the filter applies to the state recorded by the latest transition, so an entry's live state may already differ. Catch-up confidences are the figures recorded at the latest transition (null once the judgement has moved on) — a page never replays the queue; workCenterTwinShadow recomputes them. Requires workCenterBehaviorProfile:read permission.
"""
workCenterTwinShadows(
"""Optional filters"""
filter: WorkCenterTwinShadowFilterInput
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Number of items from the end"""
last: Int
"""Cursor to end before"""
before: String
): WorkCenterTwinShadowConnection! @topic(names: ["jobs"])
"""
A work centre's twin transitions, newest first, of both tracks unless `track` narrows them. Requires workCenterBehaviorProfile:read permission.
"""
workCenterTwinEvents(
"""The work centre whose transitions to list"""
workCenterId: WorkCenterID!
"""Only transitions of this track; omit for both"""
track: WorkCenterTwinTrack
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Number of items from the end"""
last: Int
"""Cursor to end before"""
before: String
): WorkCenterTwinEventConnection! @topic(names: ["jobs"])
"""
Project one work centre over the next N hours: per-shift bands of expected busy and lost minutes, a down-probability strip and per-allocation ends, from the machine's behaviour profile and its published plan. Synchronous; persists nothing. Bounded by TWIN_MAX_SYNC_SAMPLES, 336 hours and 50 hypothetical allocations. Requires scenarioSimulationRun:execute.
"""
projectWorkCenterTwin(
"""The work centre, the window and sampling options"""
input: WorkCenterTwinProjectionInput!
): WorkCenterTwinProjection! @topic(names: ["jobs"])
"""Fetch a template by ID. Requires template:read permission."""
getTemplate(
"""Template ID to fetch"""
id: TemplateID!
): TemplateState @topic(names: ["workflows", "scripting"])
"""Fetch a template by handle. Requires template:read permission."""
getTemplateByHandle(
"""Template handle to fetch"""
handle: String!
): TemplateState @topic(names: ["workflows", "scripting"])
"""
List templates with pagination and filtering. Requires template:list permission.
"""
listTemplates(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: TemplateFilterInput
"""Sort order"""
sort: [TemplateSortInput!]
): TemplateConnection! @topic(names: ["workflows", "scripting"])
"""Fetch one template version by ID. Requires template:read permission."""
getTemplateVersion(
"""Template version ID to fetch"""
id: TemplateVersionID!
): TemplateVersionState @topic(names: ["workflows", "scripting"])
"""
List versions of a template with pagination. Requires template:read permission.
"""
listTemplateVersions(
"""Template ID to list versions for"""
templateId: TemplateID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): TemplateVersionConnection! @topic(names: ["workflows", "scripting"])
"""Fetch a file by ID. Requires file:read permission."""
getFile(
"""File ID to fetch"""
id: FileID!
): FileState @topic(names: ["files"]) @topic_example(names: ["prepress.read-file"])
"""
List files with pagination and filtering. Requires file:list permission.
"""
listFiles(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: FileFilterInput
"""Sort order"""
sort: [FileSortInput!]
): FileConnection! @topic(names: ["files"])
"""
Fetch a single warehouse location in the caller's tenant by id; null when no such location exists. Requires warehouseLocation:read permission.
"""
getWarehouseLocation(
"""TypeID ("wlc") of the warehouse location to fetch."""
id: WarehouseLocationID!
): WarehouseLocationState @topic(names: ["logistics"])
"""
List the caller's tenant's warehouse locations, filtered and sorted, as a paginated connection. Requires warehouseLocation:list permission.
"""
listWarehouseLocations(
"""
Maximum number of locations to return from the start of the page. Defaults to 20; values above the server's page-size limit (100) are rejected.
"""
first: Int
"""
Opaque cursor from a previous page's endCursor: the page starts at the location immediately after it, in the requested sort order.
"""
after: String
"""
Narrows the locations returned; omit to list all of the tenant's locations.
"""
filter: WarehouseLocationFilterInput
"""
Ordering rules to apply. Only the first rule is honoured, and both its field and direction are applied; omit to order by creation time, newest first.
"""
sort: [WarehouseLocationSortInput!]
): WarehouseLocationConnection! @topic(names: ["logistics"])
"""
Fetch a single warehouse stock record in the caller's tenant. Returns null when no such record exists. Requires read access to warehouse stock.
"""
getWarehouseStock(
"""WarehouseStock TypeID (`wst_…`) of the record to fetch."""
id: WarehouseStockID!
): WarehouseStockState @topic(names: ["logistics"])
"""
List the warehouse stock records in the caller's tenant, filtered, sorted and paginated. Requires list access to warehouse stock.
"""
listWarehouseStocks(
"""
Maximum number of records to return in this page. Defaults to 20; values above the server's page-size limit (100) are rejected.
"""
first: Int
"""
Cursor of the last edge of the previous page (an edge `cursor`); the page starts at the record immediately after it, in the requested sort order.
"""
after: String
"""
Criteria narrowing which stock records are listed. Omit to list all records in the tenant.
"""
filter: WarehouseStockFilterInput
"""
Ordering instructions; only the first entry is applied, and both its field and direction are honoured. Omit to order by creation time, newest first.
"""
sort: [WarehouseStockSortInput!]
): WarehouseStockConnection! @topic(names: ["logistics"])
"""
Read an input allocation in the current tenant; requires warehouse stock read permission
"""
getMaterialLot(
"""Allocation identifier within the current tenant"""
id: MaterialLotID!
): MaterialLot @topic(names: ["logistics"])
"""
Read a durable operation output in the current tenant; requires operation read permission
"""
getOperationProduct(
"""Output identity within the current tenant"""
id: OperationProductID!
): OperationProduct @topic(names: ["jobs"])
"""
Fetch a single warehouse transfer in the caller's tenant, or null when no such transfer exists. Requires warehouseTransfer:read permission.
"""
getWarehouseTransfer(
"""TypeID of the transfer to fetch (prefix "wtr")."""
id: WarehouseTransferID!
): WarehouseTransferState @topic(names: ["logistics"])
"""
List the warehouse transfers in the caller's tenant as a paginated connection. Requires warehouseTransfer:list permission.
"""
listWarehouseTransfers(
"""
Maximum number of transfers to return. Defaults to 20; values above the server's page-size limit (100) are rejected.
"""
first: Int
"""
Cursor from a previous page's endCursor: the page starts at the transfer immediately after it, in the requested sort order.
"""
after: String
"""
Criteria narrowing which transfers are returned; unfiltered when omitted.
"""
filter: WarehouseTransferFilterInput
"""
Sort order; only the first entry is applied, and both its field and direction are honoured. Ordered by creation time, newest first, when omitted.
"""
sort: [WarehouseTransferSortInput!]
): WarehouseTransferConnection! @topic(names: ["logistics"])
"""Fetch a carrier by ID. Requires carrier:read permission."""
getCarrier(
"""Carrier ID to fetch"""
id: CarrierID!
): CarrierState @topic(names: ["logistics"])
"""List carriers with pagination. Requires carrier:list permission."""
listCarriers(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: CarrierFilterInput
"""Sort order"""
sort: [CarrierSortInput!]
): CarrierConnection! @topic(names: ["logistics"])
"""Fetch a shipment by ID. Requires shipment:read permission."""
getShipment(
"""Shipment ID to fetch"""
id: ShipmentID!
): ShipmentState @topic(names: ["logistics"])
"""List shipments with pagination. Requires shipment:list permission."""
listShipments(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ShipmentFilterInput
"""Sort order"""
sort: [ShipmentSortInput!]
): ShipmentConnection! @topic(names: ["logistics"])
"""Fetch a shipment package by ID. Requires shipment:read permission."""
getShipmentPackage(
"""Shipment package ID to fetch"""
id: ShipmentPackageID!
): ShipmentPackageState @topic(names: ["logistics"])
"""
List shipment packages with pagination. Requires shipment:list permission.
"""
listShipmentPackages(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ShipmentPackageFilterInput
"""Sort order"""
sort: [ShipmentPackageSortInput!]
): ShipmentPackageConnection! @topic(names: ["logistics"])
"""Fetch a shipment item by ID. Requires shipment:read permission."""
getShipmentItem(
"""Shipment item ID to fetch"""
id: ShipmentItemID!
): ShipmentItemState @topic(names: ["logistics"])
"""
List shipment items with pagination. Requires shipment:list permission.
"""
listShipmentItems(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ShipmentItemFilterInput
"""Sort order"""
sort: [ShipmentItemSortInput!]
): ShipmentItemConnection! @topic(names: ["logistics"])
"""getPlannedDelivery; requires plannedDelivery:read"""
getPlannedDelivery(
"""Typed resource identifier"""
id: PlannedDeliveryID!
): PlannedDeliveryState @topic(names: ["logistics"])
"""listPlannedDeliveries; requires plannedDelivery:list"""
listPlannedDeliveries(
"""Maximum number of records to return"""
first: Int
"""Opaque cursor from the previous page"""
after: String
"""Optional customer associated with this planned delivery"""
customerId: CustomerID
): PlannedDeliveryConnection! @topic(names: ["logistics"])
"""getPlannedDeliveryItem; requires plannedDelivery:read"""
getPlannedDeliveryItem(
"""Typed resource identifier"""
id: PlannedDeliveryItemID!
): PlannedDeliveryItemState @topic(names: ["logistics"])
"""listPlannedDeliveryItems; requires plannedDelivery:list"""
listPlannedDeliveryItems(
"""Maximum number of records to return"""
first: Int
"""Opaque cursor from the previous page"""
after: String
"""Parent planned delivery identifier"""
plannedDeliveryId: PlannedDeliveryID
"""Optional existing job identifying the requested contents"""
jobId: JobID
): PlannedDeliveryItemConnection! @topic(names: ["logistics"])
"""getShipmentItemAllocation; requires plannedDelivery:read"""
getShipmentItemAllocation(
"""Typed resource identifier"""
id: ShipmentItemAllocationID!
): ShipmentItemAllocationState @topic(names: ["logistics"])
"""listShipmentItemAllocations; requires plannedDelivery:list"""
listShipmentItemAllocations(
"""Maximum number of records to return"""
first: Int
"""Opaque cursor from the previous page"""
after: String
"""Existing physical shipment item identifier"""
shipmentItemId: ShipmentItemID
"""Planned item receiving this allocation"""
plannedDeliveryItemId: PlannedDeliveryItemID
): ShipmentItemAllocationConnection! @topic(names: ["logistics"])
"""getFulfillmentRequirement; tenant-scoped and permission checked"""
getFulfillmentRequirement(
"""Id for this fulfillment specification"""
id: FulfillmentRequirementID!
): FulfillmentRequirement @topic(names: ["logistics"])
"""listFulfillmentRequirements; tenant-scoped and permission checked"""
listFulfillmentRequirements(
"""Owning planned delivery"""
plannedDeliveryId: PlannedDeliveryID!
"""Include retained retired records, false by default"""
includeRetired: Boolean
"""Maximum page size"""
first: Int
"""Cursor from the previous page"""
after: String
): FulfillmentRequirementConnection! @topic(names: ["logistics"])
"""getCustomerFulfillmentDefault; tenant-scoped and permission checked"""
getCustomerFulfillmentDefault(
"""Id for this fulfillment specification"""
id: CustomerFulfillmentDefaultID!
): CustomerFulfillmentDefault @topic(names: ["logistics"])
"""listCustomerFulfillmentDefaults; tenant-scoped and permission checked"""
listCustomerFulfillmentDefaults(
"""
Explicit customer supplying defaults; never inferred from recipient or billing
"""
customerId: CustomerID!
"""Include retained retired records, false by default"""
includeRetired: Boolean
"""Maximum page size"""
first: Int
"""Cursor from the previous page"""
after: String
): CustomerFulfillmentDefaultConnection! @topic(names: ["logistics"])
"""
Authoritative copied/local requirements and explicit exceptions, with review diagnostics; does not infer execution satisfaction
"""
effectiveFulfillmentRequirements(
"""
Delivery or item to compose; item composition also includes delivery-wide requirements
"""
scope: FulfillmentRequirementScopeInput!
): FulfillmentRequirementComposition! @topic(names: ["logistics"])
"""
getShipmentItemEvidence; tenant-scoped evidence without inferred completion
"""
getShipmentItemEvidence(
"""id filter or identity"""
id: ShipmentItemEvidenceIDSpecTypedID!
): ShipmentItemEvidence @topic(names: ["logistics"])
"""
listShipmentItemEvidence; tenant-scoped evidence without inferred completion
"""
listShipmentItemEvidence(
"""shipmentItemId filter or identity"""
shipmentItemId: ShipmentItemID!
"""first filter or identity"""
first: Int
"""after filter or identity"""
after: String
): ShipmentItemEvidenceConnection! @topic(names: ["logistics"])
"""
shipmentItemExecutionBalance; tenant-scoped evidence without inferred completion
"""
shipmentItemExecutionBalance(
"""shipmentItemId filter or identity"""
shipmentItemId: ShipmentItemID!
): ShipmentItemExecutionBalance! @topic(names: ["logistics"])
"""
plannedItemFulfillmentBalance; tenant-scoped evidence without inferred completion
"""
plannedItemFulfillmentBalance(
"""plannedDeliveryItemId filter or identity"""
plannedDeliveryItemId: PlannedDeliveryItemID!
): PlannedItemFulfillmentBalance! @topic(names: ["logistics"]) @topic_example(names: ["logistics.read-delivery-balance"])
"""
getRequirementEvidence; read-only, no inferred completion or macro gate
"""
getRequirementEvidence(
"""id; explicit assessment context"""
id: RequirementEvidenceIDSpecTypedID!
): RequirementEvidence @topic(names: ["logistics"])
"""
listRequirementEvidence; read-only, no inferred completion or macro gate
"""
listRequirementEvidence(
"""requirementId; explicit assessment context"""
requirementId: FulfillmentRequirementID!
"""first; explicit assessment context"""
first: Int
"""after; explicit assessment context"""
after: String
): RequirementEvidenceConnection! @topic(names: ["logistics"])
"""
assessFulfillmentRequirements; read-only, no inferred completion or macro gate
"""
assessFulfillmentRequirements(
"""scope; explicit assessment context"""
scope: FulfillmentRequirementScopeInput!
"""
Explicit gross execution stage: DISPATCH or RECEIPT; RETURN is not a completion basis
"""
quantityStage: ShipmentEvidenceStage!
"""event; explicit assessment context"""
event: RequirementLogisticsEvent
"""
Optional prospective event time, paired with event; used only to assess prerequisite ordering
"""
eventTime: DeliveryTimeInput
): FulfillmentRequirementAssessment! @topic(names: ["logistics"])
"""
Review a planned item using shared balances, effective requirements, assessment and authorized notes
"""
plannedItemReview(
"""Item to review"""
plannedDeliveryItemId: PlannedDeliveryItemID!
"""DISPATCH or RECEIPT, independent of tenant completion policy"""
quantityStage: ShipmentEvidenceStage!
"""Item notes page size, 1 through 200"""
notesFirst: Int
"""Continue the item notes page"""
notesAfter: String
): PlannedItemReview! @topic(names: ["logistics"])
"""
Assess current policy across every order line using explicitly attributed quantities
"""
orderFulfillmentCompletion(
"""Order whose lines and plans define completion scope"""
orderId: OrderID!
): OrderFulfillmentCompletion! @topic(names: ["commerce", "logistics"]) @topic_example(names: ["commerce.check-fulfilment"])
"""Read operational notes with current target permissions"""
getEntityNote(
"""id for authorized note retrieval"""
id: EntityNoteIDSpecTypedID!
): EntityNote @topic(names: ["jobs", "commerce", "logistics"])
"""Read operational notes with current target permissions"""
getEntityNoteBySource(
"""integrationInstanceId for authorized note retrieval"""
integrationInstanceId: IntegrationInstanceID!
"""key for authorized note retrieval"""
key: String!
): EntityNote @topic(names: ["jobs", "commerce", "logistics"])
"""Read operational notes with current target permissions"""
entityNotes(
"""filter for authorized note retrieval"""
filter: EntityNoteFilter
"""first for authorized note retrieval"""
first: Int
"""after for authorized note retrieval"""
after: String
): EntityNotePage! @topic(names: ["jobs", "commerce", "logistics"])
"""Read operational notes with current target permissions"""
searchEntityNotes(
"""query for authorized note retrieval"""
query: String!
"""filter for authorized note retrieval"""
filter: EntityNoteFilter
"""first for authorized note retrieval"""
first: Int
"""after for authorized note retrieval"""
after: String
): EntityNoteSearchPage! @topic(names: ["jobs", "commerce", "logistics"])
"""Fetch an order by ID. Requires order:read permission."""
getOrder(
"""Order ID to fetch"""
id: OrderID!
): OrderState @topic(names: ["commerce"])
"""Fetch an order by external ID. Requires order:read permission."""
getOrderBy(
"""External system identifier"""
externalId: String
): OrderState @topic(names: ["commerce"]) @topic_example(names: ["commerce.find-order"])
"""List orders with pagination. Requires order:list permission."""
listOrders(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: OrderFilterInput
"""Sort order"""
sort: [OrderSortInput!]
): OrderConnection! @topic(names: ["commerce"]) @topic_example(names: ["commerce.browse-orders"])
"""Fetch an order line by ID. Requires order:read permission."""
getOrderLine(
"""Order line ID to fetch"""
id: OrderLineID!
): OrderLineState @topic(names: ["commerce"])
"""List order lines with pagination. Requires order:list permission."""
listOrderLines(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: OrderLineFilterInput
"""Sort order"""
sort: [OrderLineSortInput!]
): OrderLineConnection! @topic(names: ["commerce"])
"""Fetch an estimate by ID. Requires estimate:read permission."""
getEstimate(
"""Estimate ID to fetch"""
id: EstimateID!
): EstimateState @topic(names: ["commerce"])
"""Fetch an estimate by external ID. Requires estimate:read permission."""
getEstimateBy(
"""External system identifier"""
externalId: String
): EstimateState @topic(names: ["commerce"])
"""
List estimates with pagination, filtering, and sorting. Requires estimate:list permission.
"""
listEstimates(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: EstimateFilterInput
"""Sort order"""
sort: [EstimateSortInput!]
): EstimateConnection! @topic(names: ["commerce"])
"""Fetch an estimate line by ID. Requires estimate:read permission."""
getEstimateLine(
"""Estimate line ID to fetch"""
id: EstimateLineID!
): EstimateLineState @topic(names: ["commerce"])
"""
List estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.
"""
listEstimateLines(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: EstimateLineFilterInput
"""Sort order"""
sort: [EstimateLineSortInput!]
): EstimateLineConnection! @topic(names: ["commerce"])
"""
List cost breakdowns for an estimate line. Requires estimate:read permission.
"""
listEstimateCostBreakdowns(
"""Estimate line ID to fetch breakdowns for"""
estimateLineId: EstimateLineID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): EstimateCostBreakdownConnection! @topic(names: ["commerce"])
"""Fetch a single invoice by ID. Requires invoice:read permission."""
getInvoice(
"""Invoice ID to fetch"""
id: InvoiceID!
): InvoiceState @topic(names: ["commerce"])
"""
List invoices with pagination, filtering, and sorting. Requires invoice:list permission.
"""
listInvoices(
"""Number of items to return from the start (forward pagination)"""
first: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Filter criteria for invoices"""
filter: InvoiceFilterInput
"""Sort order for results"""
sort: [InvoiceSortInput!]
): InvoiceConnection! @topic(names: ["commerce"])
"""Fetch a single invoice line by ID. Requires invoice:read permission."""
getInvoiceLine(
"""Invoice line ID to fetch"""
id: InvoiceLineID!
): InvoiceLineState @topic(names: ["commerce"])
"""
List invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.
"""
listInvoiceLines(
"""Number of items to return from the start (forward pagination)"""
first: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Filter criteria for invoice lines"""
filter: InvoiceLineFilterInput
"""Sort order for results"""
sort: [InvoiceLineSortInput!]
): InvoiceLineConnection! @topic(names: ["commerce"])
"""Fetch a single payment by ID. Requires payment:read permission."""
getPayment(
"""Payment ID"""
id: PaymentID!
): PaymentState @topic(names: ["commerce"])
"""List payments with pagination. Requires payment:list permission."""
listPayments(
"""Number of items to return"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria (invoiceId optional)"""
filter: PaymentFilterInput
"""Sort order"""
sort: [PaymentSortInput!]
): PaymentConnection! @topic(names: ["commerce"])
"""Fetch a single supplier by ID. Requires supplier:read permission."""
getSupplier(
"""Supplier ID to fetch"""
id: SupplierID!
): SupplierState @topic(names: ["commerce"])
"""
List suppliers with pagination, filtering, and sorting. Requires supplier:list permission.
"""
listSuppliers(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: SupplierFilterInput
"""Sort order"""
sort: [SupplierSortInput!]
): SupplierConnection! @topic(names: ["commerce"]) @topic_example(names: ["commerce.browse-suppliers"])
"""
Fetch a single purchase order by ID. Requires purchaseOrder:read permission.
"""
getPurchaseOrder(
"""Purchase order ID to fetch"""
id: PurchaseOrderID!
): PurchaseOrderState @topic(names: ["commerce"])
"""
List purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
"""
listPurchaseOrders(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: PurchaseOrderFilterInput
"""Sort order"""
sort: [PurchaseOrderSortInput!]
): PurchaseOrderConnection! @topic(names: ["commerce"])
"""
Fetch a single purchase order line by ID. Requires purchaseOrder:read permission.
"""
getPurchaseOrderLine(
"""Purchase order line ID to fetch"""
id: PurchaseOrderLineID!
): PurchaseOrderLineState @topic(names: ["commerce"])
"""
List purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
"""
listPurchaseOrderLines(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: PurchaseOrderLineFilterInput
"""Sort order"""
sort: [PurchaseOrderLineSortInput!]
): PurchaseOrderLineConnection! @topic(names: ["commerce"])
"""Fetch a single product by ID. Requires product:read permission."""
getProduct(
"""Product ID to fetch"""
id: ProductID!
): ProductState @topic(names: ["commerce"])
"""
List products with pagination, filtering, and sorting. Requires product:list permission.
"""
listProducts(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ProductFilterInput
"""Sort order"""
sort: [ProductSortInput!]
): ProductConnection! @topic(names: ["commerce"]) @topic_example(names: ["commerce.browse-products"])
"""
Fetch a single job material reservation by ID. Requires jobMaterialReservation:read permission.
"""
getJobMaterialReservation(
"""Reservation ID"""
id: JobMaterialReservationID!
): JobMaterialReservationState @topic(names: ["logistics"])
"""
List material reservations with pagination. Requires jobMaterialReservation:list permission.
"""
listJobMaterialReservations(
"""Number of items to return"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria (jobId optional)"""
filter: JobMaterialReservationFilterInput
"""Sort order"""
sort: [JobMaterialReservationSortInput!]
): JobMaterialReservationConnection! @topic(names: ["logistics"])
"""
Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.
"""
orderLifecycle(
"""
TypeID of the order to expand (`ord_01K…`). Must belong to the caller's tenant; otherwise the payload comes back empty with an `orderId: order not found` error.
"""
orderId: OrderID!
): OrderLifecyclePayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.order-lifecycle"])
"""
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
"""
customerAccountSummary(
"""
TypeID of the customer to summarise (`cus_01K…`). Must belong to the caller's tenant; otherwise the payload comes back empty with a `customerId: customer not found` error.
"""
customerId: CustomerID!
"""
Inclusive start of the window, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Filters orders by orderDate and estimates/invoices by issueDate. Omit for no lower bound; an unparseable value is ignored, not rejected.
"""
fromDate: String
"""
Exclusive end of the window, in the same ISO-8601 date-time format as `fromDate`. Omit for no upper bound; an unparseable value is ignored, not rejected.
"""
toDate: String
): CustomerAccountSummaryPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.customer-account"])
"""
Fetch active production jobs with components, operations, and order context. Requires job:list.
"""
productionBoard(
"""
Inclusive lower bound on the job's due date, as an ISO-8601 date-time with fractional seconds (e.g. "2026-01-01T00:00:00.000Z"). Omit for no lower bound; an unparseable value is ignored, not rejected.
"""
fromDate: String
"""
Exclusive upper bound on the job's due date, in the same format as `fromDate`. Omit for no upper bound; an unparseable value is ignored.
"""
toDate: String
"""
Restrict the board to jobs in these statuses. Omit to return jobs in every status; an empty list matches no jobs.
"""
statuses: [JobStatus!]
): ProductionBoardPayload! @topic(names: ["jobs"])
"""
Fetch all shipments for a given date with packages, items, and order details. Requires shipment:list.
"""
dailyDispatchManifest(
"""
The dispatch day, as a plain ISO-8601 calendar date ("YYYY-MM-DD"). Selects shipments whose shippedAt falls within that day. A value in any other format yields an empty manifest with a `date` error.
"""
date: String!
): DailyDispatchManifestPayload! @topic(names: ["logistics"])
"""
Check whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.
"""
quotingReadinessCheck: QuotingReadinessPayload! @topic(names: ["costing"]) @topic_example(names: ["erp.quoting-readiness"])
"""
Get a costing summary for a job including material and operation costs. Requires job:read.
"""
jobCostingSummary(
"""
Job to cost, as a JobID TypeID (e.g. "job_01K…"). An id that matches no job in the caller's tenant is not an error: the payload comes back with a null job, zero totals and a "job not found" entry in errors.
"""
jobId: JobID!
): JobCostingSummaryPayload! @topic(names: ["jobs", "costing"]) @topic_example(names: ["production.review-costs"])
"""
Permission-filtered MicroSQL authoring metadata and its content version. Contains logical schema only, never physical database mappings.
"""
sqlAuthoringSchema: SQLAuthoringPayload! @topic(names: ["reporting"])
"""
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.
"""
reportQuery(
"""MicroSQL query string (restricted SQL dialect)"""
query: String!
): ReportQueryPayload! @topic(names: ["reporting", "aiml"])
"""
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. Validates only against tables the caller can list.
"""
describeQuerySchema(
"""Query to analyze"""
input: DescribeQuerySchemaInput!
): QuerySchemaPayload! @topic(names: ["reporting", "aiml"])
"""Get a data clip by ID"""
getDataClip(
"""
TypeID of the clip to fetch (e.g. "dcl_01K…"). Resolves to null when no such clip exists in the caller's tenant.
"""
id: DataClipID!
): DataClipState @topic(names: ["apps"])
"""List data clips for the current tenant"""
listDataClips(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""
Cursor from a previous page's `endCursor`; the listing resumes with the clip after it. An unknown cursor is ignored and the page starts from the top.
"""
after: String
"""Optional criteria narrowing which clips are listed."""
filter: DataClipFilterInput
"""
Sort terms; only the first is applied. Defaults to the persistence layer's natural order when omitted.
"""
sort: [DataClipSortInput!]
): DataClipConnection! @topic(names: ["apps"])
"""Preview a MicroSQL query without saving (returns tabular results)"""
previewDataClip(
"""The MicroSQL query to run for preview. Nothing is persisted."""
input: PreviewDataClipInput!
): ReportQueryPayload! @topic(names: ["apps"])
"""
Analyze XML without executing queries; returns diagnostics and the live authoring vocabulary as JSON.
"""
analyzeReportSource(
"""Report or PDF XML source."""
sourceXML: String!
"""Analyze a standalone PDF template."""
pdf: Boolean
"""Optional canonical report context for PDF binding completions."""
definition: JSON
): String! @topic(names: ["reports"])
"""Losslessly export a report definition as XML."""
exportReportSource(
"""Canonical definition to export."""
definition: JSON!
): String! @topic(names: ["reports"])
"""List report data sources and their selectable columns."""
reportBuilderTables: [ReportBuilderTable!]! @topic(names: ["reports"])
"""List notification delivery attempts for a report run."""
reportDeliveries(
"""Report run identifier."""
id: ReportRunID!
): [ReportDelivery!]! @topic(names: ["reports"])
"""List starter definitions for creating reports."""
reportStarters: [ReportStarter!]! @topic(names: ["reports"])
"""List schedules pinned to a report version."""
reportSchedules(
"""Report version identifier."""
id: ReportVersionID!
): [ReportSchedule!]! @topic(names: ["reports", "reporting"])
"""List recorded firings of a report schedule."""
reportOccurrences(
"""Report schedule identifier."""
id: ReportScheduleID!
): [ReportOccurrence!]! @topic(names: ["reports", "reporting"])
"""Read a report and its draft metadata by ID."""
getReport(
"""Report identifier."""
id: ReportID!
): Report @topic(names: ["reports", "reporting"])
"""List reports in a cursor-paginated page."""
listReports(
"""Maximum number of records to return."""
first: Int
"""Continue after this resource identifier."""
after: ReportID
): ReportConnection! @topic(names: ["reports", "reporting"])
"""Read an immutable report version by ID."""
reportVersion(
"""Report version identifier."""
id: ReportVersionID!
): ReportVersion! @topic(names: ["reports", "reporting"])
"""List published versions of a report."""
reportVersions(
"""Report identifier."""
id: ReportID!
): [ReportVersion!]! @topic(names: ["reports", "reporting"])
"""Check a report definition without saving or executing it."""
validateReport(
"""Report XML source."""
sourceXML: String
"""Report definition JSON to validate."""
definition: JSON
): ReportValidationOutput! @topic(names: ["reports", "reporting"])
"""Read the progress and outcome of a report run."""
reportRun(
"""Report run identifier."""
id: ReportRunID!
): ReportRun @topic(names: ["reports", "reporting"])
"""List report runs, optionally restricted to a published version."""
reportRuns(
"""Maximum number of records to return."""
first: Int
"""Continue after this resource identifier."""
after: ReportRunID
"""Restrict runs to this immutable report version."""
versionId: ReportVersionID
): ReportRunConnection! @topic(names: ["reports", "reporting"])
"""List retained output files for a report run."""
reportArtifacts(
"""Report run identifier."""
id: ReportRunID!
): [ReportArtifact!]! @topic(names: ["reports", "reporting"])
"""
Fetch an external schema by ID. Requires externalSchema:read permission.
"""
getExternalSchema(
"""External schema ID to fetch"""
id: ExternalSchemaID!
): ExternalSchemaState @topic(names: ["apps"])
"""
List external schemas with pagination and filtering. Requires externalSchema:list permission.
"""
listExternalSchemas(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ExternalSchemaFilterInput
"""Sort order"""
sort: [ExternalSchemaSortInput!]
): ExternalSchemaConnection! @topic(names: ["apps"])
"""
List tenant API definitions, optionally restricted to one uploaded schema.
"""
listAPIClientDefinitions(
"""Maximum number of definitions to return."""
first: Int
"""Continue after this opaque cursor."""
after: String
"""Uploaded external schema supplying the pinned API description."""
externalSchemaId: ExternalSchemaID
): APIClientDefinitionConnection! @topic(names: ["apps"])
"""Read a tenant API definition and its current compilation status."""
getAPIClientDefinition(
"""API client definition identity."""
id: APIClientDefinitionID!
): APIClientDefinition @topic(names: ["apps"])
"""
List entries for an external schema. Requires externalSchema:read permission.
"""
listExternalSchemaEntries(
"""External schema ID to list entries for"""
schemaId: ExternalSchemaID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: ExternalSchemaEntryFilterInput
"""Sort order"""
sort: [ExternalSchemaEntrySortInput!]
): ExternalSchemaEntryConnection! @topic(names: ["apps"])
"""
Get current tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
"""
getConfig: TenantConfigOutput @topic(names: ["admin"])
"""
Get a specific version of tenant configuration. Secret values are redacted. Requires tenantConfig:read permission.
"""
getConfigVersion(
"""Version number to fetch"""
version: Int!
): TenantConfigOutput @topic(names: ["admin"])
"""
List version history for tenant configuration, newest first, with pagination. Requires tenantConfig:list permission.
"""
listConfigVersions(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): TenantConfigVersionConnection! @topic(names: ["admin"])
"""
Discover available vertical-specific production units. These values are used with the CUSTOM MetricUnit and the customUnit/customCountUnit/customSpeedUnit fields.
"""
verticalProductionUnits(
"""
Optional vertical identifier to filter by (e.g. 'print'). Returns all verticals if omitted.
"""
vertical: String
): [VerticalUnitDescriptor!]! @topic(names: ["integrations"])
"""
Compare retained input facts and optionally inspect attributed stock. Read-only; no technical feasibility or execution readiness guarantee. Stock checking additionally requires warehouseStock:read.
"""
assessOperationInputs(
"""
Persisted or headless requirements and explicit current facts; inventory checking is opt-in.
"""
input: AssessOperationInputsInput!
): [OperationInputAssessment!]! @topic(names: ["jobs"])
"""Evaluate whether a component can be produced by the given work centers"""
evaluateProducibility(
"""
What to evaluate (componentId or an inline spec) and, optionally, which work centers to evaluate against.
"""
input: EvaluateProducibilityInput!
): ProducibilityResultOutput! @topic(names: ["jobs"])
"""
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.
"""
producibilityIntelligence(
"""
What to analyse (componentId or an inline spec) and, optionally, which work centers to consider for routing recommendations.
"""
input: ProducibilityIntelligenceInput!
): ProducibilityIntelligenceOutput! @topic(names: ["jobs"])
"""
Preview waste, yield, duration and constant-rate pace for a stored planned operation. Optionally assess its stored plan's item statuses and downstream dependencies, plus booked timing in an explicit schedule scenario. No writes or audit events. Inspect coverage and limitations; this is not a delivery-date guarantee.
"""
previewPlannedOperationAudit(
"""Stored planned step and hypothetical cumulative progress."""
input: PreviewPlannedOperationAuditInput!
): PlannedOperationAuditPreview! @topic(names: ["jobs"])
"""
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.
"""
auditProduction(
"""
The job to audit plus the waste, yield and duration thresholds that classify findings as warning or critical. Each threshold falls back to its documented default when omitted.
"""
input: AuditProductionInput!
): AuditVerdictOutput! @topic(names: ["jobs"])
"""
Enriched production audit: same as auditProduction but additionally includes work center baseline metrics, production cell rankings, and live in-flight performance from LightTS progress hourly aggregates. Returns the same AuditVerdictOutput type with enrichments and livePerformance fields populated.
"""
auditProductionEnriched(
"""
The job to audit plus the waste, yield and duration thresholds. Same shape as auditProduction; the enrichment layers are added by the resolver, not requested here.
"""
input: AuditProductionInput!
): AuditVerdictOutput! @topic(names: ["jobs"])
"""
Which build of the platform is answering. Compare across deployments to tell them apart, or across time to notice that the server changed under a cached set of workarounds.
"""
platformInfo: PlatformInfo! @topic(names: ["admin"])
"""Semantic search over GraphQL types (objects, inputs, enums)"""
searchSchemaTypes(
"""
Natural-language search phrase; embedded and matched against type names and descriptions by cosine similarity.
"""
query: String!
"""
Maximum number of matches to return, best-scoring first. Defaults to 10.
"""
topK: Int
): [SchemaDocSearchResult!]! @topic(names: ["apps"])
"""Semantic search over GraphQL fields on types"""
searchSchemaFields(
"""
Natural-language search phrase; embedded and matched against field paths (Type.field) and descriptions by cosine similarity.
"""
query: String!
"""
Maximum number of matches to return, best-scoring first. Defaults to 10.
"""
topK: Int
): [SchemaDocSearchResult!]! @topic(names: ["apps"])
"""Semantic search over GraphQL query operations"""
searchSchemaQueries(
"""
Natural-language search phrase; embedded and matched against the names and descriptions of root Query fields by cosine similarity.
"""
query: String!
"""
Maximum number of matches to return, best-scoring first. Defaults to 10.
"""
topK: Int
): [SchemaDocSearchResult!]! @topic(names: ["apps"])
"""Semantic search over GraphQL mutation operations"""
searchSchemaMutations(
"""
Natural-language search phrase; embedded and matched against the names and descriptions of root Mutation fields by cosine similarity.
"""
query: String!
"""
Maximum number of matches to return, best-scoring first. Defaults to 10.
"""
topK: Int
): [SchemaDocSearchResult!]! @topic(names: ["apps"])
"""
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.
"""
getS3Backend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): S3Backend @topic(names: ["files"])
"""
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.
"""
getHostPathBackend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): HostPathBackend @topic(names: ["files"])
"""
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.
"""
getFTPBackend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): FTPBackend @topic(names: ["files"])
"""
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.
"""
getGoogleDriveBackend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): GoogleDriveBackend @topic(names: ["files"])
"""
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.
"""
getDropboxBackend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): DropboxBackend @topic(names: ["files"])
"""
Fetch one storage backend by id. Null when no backend with that id exists in the caller's tenant. Requires storageBackend:read permission.
"""
getStorageBackend(
"""TypeID (`sbk_` prefix) of the backend to fetch."""
id: StorageBackendID!
): StorageBackendOutput @topic(names: ["files"])
"""
List the calling tenant's storage backends. Requires storageBackend:list permission.
"""
listStorageBackends(
"""
Maximum number of backends to return. Defaults to 100; values above the server's page-size limit (100) are rejected.
"""
first: Int
"""
Forward-pagination cursor (an edge's cursor): the page starts at the backend immediately after it, in the requested sort order.
"""
after: String
"""
Narrows the backends returned. Omit to list all of the tenant's backends.
"""
filter: StorageBackendFilterInput
"""
Ordering rules; only the first entry is applied, and both its field and direction are honoured. Omit to order by creation time, newest first.
"""
sort: [StorageBackendSortInput!]
): StorageBackendConnection! @topic(names: ["files"])
"""
Which storage backend kinds this deployment supports, so a client can hide unusable options. Requires storageBackend:list permission.
"""
storageCapabilities: StorageCapabilitiesOutput! @topic(names: ["files"])
"""
Fetch a single archive job by id, scoped to the caller's tenant. Null if no such job exists. Requires archiveJob:read permission.
"""
getArchiveJob(
"""TypeID (prefix `arj`) of the archive job to fetch."""
id: ArchiveJobID!
): ArchiveJobOutput @topic(names: ["admin"])
"""
List the tenant's archive jobs as a cursor-paginated connection, filtered and sorted in the database. Requires archiveJob:list permission.
"""
listArchiveJobs(
"""
Number of items from the start of the page. Defaults to 100; values above 100 are rejected.
"""
first: Int
"""
Cursor to start after — an `ArchiveJobEdge.cursor` value from a previous page. Resumes the listing at the row following that cursor, under the same `filter` and `sort`.
"""
after: String
"""
Optional name / slug / isEnabled filters. Omit to list every archive job in the tenant.
"""
filter: ArchiveJobFilterInput
"""
Ordering rules; only the first is applied. Omit to order by creation time, newest first.
"""
sort: [ArchiveJobSortInput!]
): ArchiveJobConnection! @topic(names: ["admin"])
"""
A single archive execution by id, or null if no such execution exists in the caller's tenant. Requires archiveExecution:read permission.
"""
getArchiveExecution(
"""TypeID of the execution to fetch, prefixed "arx" (e.g. "arx_01K…")."""
id: ArchiveExecutionID!
): ArchiveExecutionOutput @topic(names: ["admin"])
"""
Run history for one archive job, newest run first (by startedAt), with pagination. Scoped to the caller's tenant. Requires archiveExecution:list permission.
"""
listArchiveExecutions(
"""
TypeID of the archive job whose runs to list, prefixed "arj" (e.g. "arj_01K…").
"""
archiveJobId: ArchiveJobID!
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
): ArchiveExecutionConnection! @topic(names: ["admin"])
"""
A single folder in the caller's tenant, or null when no folder with that id exists there. Requires folder:read permission.
"""
folder(
"""TypeID of the folder to fetch (e.g. "fld_01K…")."""
id: FolderID!
): Folder @topic(names: ["files"])
"""
Folders in the caller's tenant, filtered and sorted, as a connection. Requires folder:list permission.
"""
folders(
"""
Page size, 0 to 100 (default 25). A value outside that range returns a PAGE_SIZE_NEGATIVE or PAGE_SIZE_EXCEEDED error.
"""
first: Int
"""
Cursor from a previous page's edge (a folder TypeID) to continue after. The listing resumes at the folder following that cursor, under the same `filter` and `sort`. A cursor that matches no folder in the result set is ignored and the first page is returned.
"""
after: String
"""
Narrow the result set by name and/or binding kind. Omit to list every folder in the tenant.
"""
filter: FolderFilterInput
"""
Sort keys; only the first is applied. Defaults to creation time, newest first, when omitted.
"""
sort: [FolderSortInput!]
): FolderConnection! @topic(names: ["files"]) @topic_example(names: ["prepress.browse-folders"])
"""
Read accepted message metadata and managed File references under its InboxFolder permissions.
"""
inboxMessage(
"""InboxMessage ID passed as the event dataQuery $id."""
id: InboxMessageID!
): InboxMessage @topic(names: ["files"])
"""Read a mailbox configuration in this tenant."""
inboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
): InboxFolder @topic(names: ["files"])
"""
Read bounded mailbox runtime health without credentials or message content.
"""
inboxFolderHealth(
"""InboxFolder ID."""
id: InboxFolderID!
): InboxFolderHealthOutput @topic(names: ["files"])
"""List mailbox configurations without credentials."""
inboxFolders(
"""Page size between 1 and 100; defaults to 25."""
first: Int
"""Last InboxFolder ID from the previous page, ordered by ID."""
after: InboxFolderID
): [InboxFolder!]! @topic(names: ["files"])
"""Keyset page mailbox intake/status records. Requires inboxFolder:list."""
inboxMessages(
"""Mailbox whose messages to list."""
inboxFolderId: InboxFolderID!
"""Page size, 1 to 100."""
first: Int
"""`nextAfter` from the previous page; omit for the first page."""
after: InboxMessageID
): InboxMessageStatusPage! @topic(names: ["files"])
"""
Keyset page workflow delivery and execution status independently from intake status.
"""
inboxDeliveries(
"""Mailbox whose deliveries to list."""
inboxFolderId: InboxFolderID!
"""Page size, 1 to 100."""
first: Int
"""`nextAfter` from the previous page; omit for the first page."""
after: String
): InboxDeliveryStatusPage! @topic(names: ["files"])
"""
Read retained accepted MIME bytes with inbox, file, report, and Folder authorization.
"""
inboxMessageContent(
"""Accepted message whose content to read."""
id: InboxMessageID!
): InboxMessageContent @topic(names: ["files"])
"""
Separately permissioned and audited access to bounded staged quarantine bytes; no File/Folder URL is exposed.
"""
inboxQuarantineInspection(
"""Quarantined message to inspect."""
id: InboxMessageID!
"""Audited reason for the inspection, 1 to 1000 UTF-8 bytes."""
reason: String!
"""First byte to return; omit to start at the beginning."""
byteOffset: Int
"""Maximum bytes to return, 1 to 1048576."""
byteLimit: Int
): InboxQuarantineInspection @topic(names: ["files"])
"""
Keyset page durable review, inspection, hold, replay, and delivery-dismissal audit records.
"""
inboxMessageActivity(
"""Message whose audit records to list."""
id: InboxMessageID!
"""Page size, 1 to 100."""
first: Int
"""`nextAfter` from the previous page; omit for the first page."""
after: String
): InboxMessageActivityPage! @topic(names: ["files"])
"""Bounded tenant-scoped page of hold owners, reasons, and expiry state."""
inboxMessageHolds(
"""Mailbox whose holds to list."""
inboxFolderId: InboxFolderID!
"""Page size, 1 to 100."""
first: Int
"""`nextAfter` from the previous page; omit for the first page."""
after: String
): InboxMessageHoldPage! @topic(names: ["files"])
"""
Bounded sample of expired eligible and held messages, plus the next configured expiry.
"""
inboxRetentionPreview(
"""Mailbox to preview."""
inboxFolderId: InboxFolderID!
): InboxRetentionPreview @topic(names: ["files"])
"""
Read whether the current sender and submission credential have explicit operator approval.
"""
inboxSenderAuthorization(
"""Mailbox whose sender approval to read."""
inboxFolderId: InboxFolderID!
): InboxSenderAuthorizationStatus! @topic(names: ["files"])
"""
Read safe outbound status for callers authorized to execute within the inbox.
"""
inboxOutboundStatus(
"""Outbound message identifier returned when the reply was requested."""
id: InboxOutboundID!
): InboxOutboundStatus @topic(names: ["files"])
"""
Keyset page safe outbox statuses for authorized operators, including unknown deliveries.
"""
inboxOutboundStatuses(
"""Mailbox whose outbox to list."""
inboxFolderId: InboxFolderID!
"""Page size, 1 to 100."""
first: Int
"""`nextAfter` from the previous page; omit for the first page."""
after: String
): InboxOutboundStatusPage! @topic(names: ["files"])
"""Fetch a single concept by ID. Requires concept:read permission."""
concept(
"""Concept ID to fetch."""
id: ConceptID!
): Concept @topic(names: ["aiml"])
"""
List the tenant's concepts with pagination. Requires concept:list permission.
"""
concepts(
"""Number of concepts to return from the start."""
first: Int
"""Cursor to page after."""
after: String
"""Filter criteria."""
filter: ConceptFilterInput
"""Sort order."""
sort: [ConceptSortInput!]
): ConceptConnection! @topic(names: ["aiml"])
"""
Fetch a single knowledge note by ID. Requires knowledgeNote:read permission.
"""
knowledgeNote(
"""Knowledge note ID to fetch."""
id: KnowledgeNoteID!
): KnowledgeNote @topic(names: ["aiml"])
"""
List knowledge notes with pagination and filtering. A direct query over the store; for situational relevance use `retrieveKnowledge`. Requires knowledgeNote:list permission.
"""
knowledgeNotes(
"""Number of notes to return from the start."""
first: Int
"""Cursor to page after."""
after: String
"""Filter criteria."""
filter: KnowledgeNoteFilterInput
"""Sort order."""
sort: [KnowledgeNoteSortInput!]
): KnowledgeNoteConnection! @topic(names: ["aiml"])
"""
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.
"""
retrieveKnowledge(
"""
Entities the caller is currently working with, as TypeIDs (e.g. "wcr_01K…"); each prefix names the entity kind. Retrieval expands the situational graph outward from these to find related knowledge.
"""
seeds: [ID!]!
"""
Optional free-text intent. Ranks results by semantic similarity and pulls in graph-unreached notes as `supporting`.
"""
query: String
"""Maximum number of notes to return per bucket."""
limit: Int
): KnowledgeRetrieval! @topic(names: ["aiml"])
"""
Lineage subgraph (nodes + edges) around a fulfillment entity. Requires fulfillment:read permission.
"""
fulfillmentTrace(
"""
TypeID of the seed entity (e.g. "ord_01K…"); its prefix names the entity kind.
"""
entityId: ID!
"""Maximum traversal depth. Defaults to 5."""
maxDepth: Int
"""
Traversal direction: "downstream", "upstream", or "both". Defaults to "both".
"""
direction: String
): GraphTrace! @topic(names: ["logistics"])
"""
Entities reachable up/downstream from a fulfillment entity (the seed is excluded). Requires fulfillment:read permission.
"""
fulfillmentImpact(
"""
TypeID of the seed entity (e.g. "ord_01K…"); its prefix names the entity kind.
"""
entityId: ID!
"""
Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".
"""
direction: String
"""Maximum traversal depth. Defaults to 5."""
maxDepth: Int
): [GraphNode!]! @topic(names: ["logistics"])
"""
Cross-layer lineage subgraph (nodes + edges) around a provenance entity, over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
"""
provenanceTrace(
"""
TypeID of the seed entity (e.g. "ord_01K…"); its prefix names the entity kind.
"""
entityId: ID!
"""Maximum traversal depth. Defaults to 5."""
maxDepth: Int
"""
Traversal direction: "downstream", "upstream", or "both". Defaults to "both".
"""
direction: String
): GraphTrace! @topic(names: ["logistics"])
"""
Entities reachable up/downstream from a provenance entity (the seed is excluded), over the structural composite (operational + fulfillment + provenance). Requires provenance:read permission.
"""
provenanceImpact(
"""
TypeID of the seed entity (e.g. "ord_01K…"); its prefix names the entity kind.
"""
entityId: ID!
"""
Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".
"""
direction: String
"""Maximum traversal depth. Defaults to 5."""
maxDepth: Int
): [GraphNode!]! @topic(names: ["logistics"])
"""
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.
"""
whatIf(
"""TypeIDs of the entities to start the hypothetical walk from."""
seeds: [ID!]!
"""Hypothetical edges to union into the walk (never persisted)."""
extraEdges: [WhatIfEdgeInput!]!
"""
Traversal direction: "downstream", "upstream", or "both". Defaults to "downstream".
"""
direction: String
"""Maximum traversal depth. Defaults to 5."""
maxDepth: Int
"""
Graph to walk: "fulfillment", "provenance", or "structural". Defaults to "structural".
"""
graph: String
): WhatIfResult! @topic(names: ["logistics"])
"""
Fetch a component artwork file reference by ID. Requires componentArtworkFile:read permission.
"""
getComponentArtworkFile(
"""Artwork file reference ID to fetch"""
id: ComponentArtworkFileID!
): ComponentArtworkFileState @topic(names: ["print.prepress"])
"""
List artwork file references for a component. Requires componentArtworkFile:list permission.
"""
listComponentArtworkFiles(
"""Component ID to list artwork files for"""
componentId: ComponentID!
): [ComponentArtworkFileState!]! @topic(names: ["print.prepress"])
"""
Validate and prepare a saved form Layout and original source signatures without producing inventory
"""
prepareBatchForm(
"""Saved form and optional managed artwork selections"""
input: BatchFormPreparationInput!
): BatchFormProductResult! @topic(names: ["print.prepress"])
"""
Render the saved form Layout from managed source PDFs, retaining each source signature identity
"""
renderBatchForm(
"""Saved form and optional managed artwork selections"""
input: BatchFormPreparationInput!
): BatchFormProductResult! @topic(names: ["print.prepress"])
"""
Fetch an imposition spec by ID. Requires impositionSpec:read permission.
"""
getImpositionSpec(
"""Imposition spec ID to fetch"""
id: ImpositionSpecID!
): ImpositionSpecState @topic(names: ["print.prepress"])
"""
Fetch an imposition spec by external ID. Requires impositionSpec:read permission.
"""
getImpositionSpecBy(
"""
External system identifier, resolved in the calling integration's namespace
"""
externalId: String!
): ImpositionSpecState @topic(names: ["print.prepress"])
"""
List imposition specs for exactly one component or batch form. Requires impositionSpec:list permission.
"""
listImpositionSpecs(
"""List specifications owned by this form; omit componentId"""
batchComponentId: BatchComponentID
"""Component ID to list imposition specs for"""
componentId: ComponentID
): [ImpositionSpecState!]! @topic(names: ["print.prepress"])
"""
Derive finishing geometry without persistence. Requires impositionSpec:execute. Supply impositionSpecId or layout.
"""
consolidateImpositionFinishing(
"""Stored imposition identity or inline layout to consolidate."""
input: ConsolidateFinishingInput!
): ConsolidateFinishingPayload! @topic(names: ["print.prepress"])
"""
Plan explicit rectangular label lanes and reconcile SKU demand and overrun without persistence. Includes cyclic bleed clearances and stock length. Does not certify tooling, slitting, matrix stripping or rewind delivery.
"""
previewRollLabels(
"""Authoritative planning request and optional output settings."""
input: PreviewRollLabelsInput!
): PreviewRollLabelsPayload! @topic(names: ["print.prepress"])
"""
Reconcile explicit softcover or case-wrap construction against a calibrated physical book block without persistence. Rejects inconsistent spine, face dimensions, recipe revision and binding direction. Does not generate production artwork.
"""
previewBookCover(
"""Authoritative planning request and optional output settings."""
input: PreviewBookCoverInput!
): PreviewBookCoverPayload! @deprecated(reason: "Use planBookCover with typed job, component or headless inputs and shared units, then renderBookCover. Existing JSON requests remain supported.") @topic(names: ["print.prepress"])
"""
Plan native-size source crops and right/top overlaps without persistence. At most 256 panels; output panel dimensions 3–14400 PDF points. Row-major, bottom row first. No implicit scaling, assembly marks or device finishing instructions.
"""
previewWideFormatTiling(
"""Legacy integer-micrometre JSON request and optional source page."""
input: PreviewWideFormatTilingInput!
): PreviewWideFormatTilingPayload! @deprecated(reason: "Use planWideFormatTiling with LengthInput quantities, then renderWideFormatTiling with the typed plan. Existing JSON requests remain supported.") @topic(names: ["print.prepress"])
"""
Verify a stored print/cut ZIP against independently supplied current geometry, bindings and tenant source PDFs. Requires impositionSpec:read, file:read and file:download. Refuses unavailable, failed, changed or inconsistent artifacts. Read-only; does not record approval or certify a device.
"""
verifyShapePrintCutBundle(
"""Bundle file and current plan/source bindings to compare."""
input: VerifyShapePrintCutBundleInput!
): VerifyShapePrintCutBundlePayload! @topic(names: ["print.prepress"])
"""
Plan and independently validate a bounded batch of polygonal pieces without persistence. Deterministic orthogonal heuristic, not an optimum guarantee. At most 256 pieces and 4096 placed vertices; hole nesting requires explicit opt-in. Produces geometry only, not a production PDF or cutter programme.
"""
previewShapeNesting(
"""
Nesting requirements, optional artwork and cut-geometry export selection.
"""
input: PreviewShapeNestingInput!
): PreviewShapeNestingPayload! @topic(names: ["print.prepress"])
"""
Preview imposition layout without creating records. Used for estimation when no component exists yet.
"""
previewImposition(
"""Preview imposition parameters (estimate mode)"""
input: PreviewImpositionInput!
): PreviewImpositionPayload! @topic(names: ["print.prepress"])
"""
List all available fold patterns from the catalog. Requires authentication.
"""
listFoldPatterns: FoldCatalogPayload! @topic(names: ["print.prepress"])
"""
Compose real source PDF pages using a previously calculated signature, repeat, cut-stack or wide-format tiling plan. Returns PDF bytes without persistence or cloud storage; does not calculate geometry or repeat forms by quantity. Requires impositionSpec:execute permission and the native PDF-Writer backend.
"""
imposePdfInline(
"""
Separately calculated signature, repeat, cut-stack or wide-format tiling geometry and the source PDF bytes.
"""
input: ImposePdfInlineInput!
): ImposePdfInlinePayload! @topic(names: ["print.prepress"])
"""
Render an imposition layout as SVG. Provide either impositionSpecId or layout. Requires impositionSpec:execute permission.
"""
renderImpositionSVG(
"""SVG render parameters"""
input: RenderImpositionSVGInput!
): RenderImpositionSVGPayload! @topic(names: ["print.prepress"])
"""
Calculate up to 256 native-scale panels with typed quantities. No PDF inspection, persistence, machine selection or cutting setup. Requires impositionSpec:read.
"""
planWideFormatTiling(
"""
Design dimensions, usable panel limits, overlap and optional seams with explicit units.
"""
input: WideFormatRequirementsInput!
): PlanWideFormatTilingPayload! @topic(names: ["print.prepress"])
"""
Render one PDF page per typed panel, either from explicit geometry or identity-checked planning replay. Does not persist output. Source dimensions must match the design at native scale. Returns the existing inline PDF payload. Requires impositionSpec:execute.
"""
renderWideFormatTiling(
"""
Validated selected plan and the physical source PDF page to crop at native scale.
"""
input: RenderWideFormatTilingInput!
): ImposePdfInlinePayload! @topic(names: ["print.prepress"])
"""
Resolve one book and calculate its block and cover. Job/component sources additionally require job:read, component:read and substrate:read. No persistence or automatic acceptance of inference.
"""
planBookCover(
"""
Exactly one product source, physical overrides and explicit construction parameters, using shared units.
"""
input: PlanBookCoverInput!
): PlanBookCoverPayload! @topic(names: ["print.prepress"])
"""
Validate and render the typed cover plan. Persisted snapshots require job:read, component:read and substrate:read and are checked for freshness. Returns inline PDF data; does not create files, batches or operations.
"""
renderBookCover(
"""
Selected typed plan and one preassembled exterior spread page at native scale.
"""
input: RenderBookCoverInput!
): ImposePdfInlinePayload! @topic(names: ["print.prepress"])
"""
Plan a gathered or explicitly nested cross-component book without writes or PDF downloads. Persisted routes additionally require job:read, component:read, substrate:read, componentArtworkFile:read and file:read. Existing JSON APIs are unchanged.
"""
planBookContent(
"""
One job, a same-job component selection, or headless contributions with explicit assembly and source ranges.
"""
input: PlanBookContentInput!
): PlanBookContentPayload! @topic(names: ["print.prepress"])
"""
Resolve a book and inspect actual PDFs without composing output. Requires impositionSpec:read. Managed routes also require all planning read permissions and file:download. Sources are limited to 16 MiB each and 32 MiB combined.
"""
prepareBookContentRender(
"""
Typed planning request, headless documents when needed, and optional expected identities.
"""
input: BookContentRenderInput!
): BookContentRenderPayload! @topic(names: ["print.prepress"])
"""
Render typed job, component-selection or headless book contributions from captured source bytes. Requires impositionSpec:execute. Managed routes also require planning read permissions and file:download. Checks expected identities when supplied. Returns all component outputs or none; no storage writes. Sources are limited to 16 MiB each and 32 MiB combined; combined output is limited to 32 MiB.
"""
renderBookContent(
"""
Typed planning request, headless documents when needed, and optional expected identities.
"""
input: BookContentRenderInput!
): BookContentRenderPayload! @topic(names: ["print.prepress"])
"""
Read and inspect a retained print sheet product. Returns null for an absent or non-print product. Requires operation read permission; no file download or inventory change occurs.
"""
getPrintOperationProduct(
"""Existing durable product identity within the current tenant."""
id: OperationProductID!
): PrintOperationProductView @topic(names: ["print.prepress"])
"""
Find every qualified signature of a job across existing plans, current operation work and historical retained products. Requires job, component, imposition-spec and operation read permissions. Reports unknown legacy identities explicitly; neither publication nor physical production is inferred.
"""
jobSignatures(
"""
Job selection, bounded page size, optional continuation and optional stock visibility.
"""
input: JobSignaturesInput!
): JobSignaturesPage! @topic(names: ["print.prepress"])
"""
Replan and validate managed source bytes for physical sheet products without writing records. Existing impositionSpec read and managed file download permissions are also required.
"""
prepareSheetProducts(
"""
Existing component planning configuration and optional artwork selection.
"""
input: PrepareSheetProductsInput!
): PreparedPrintProductsResult! @topic(names: ["print.prepress"])
"""
Validate full-material fold geometry and retained production identity without writes or source downloads. Preserves historical printed artwork even when the current artwork changes.
"""
prepareFoldedProducts(
"""
Between one and 256 existing printed-input/folding-producer selections.
"""
selections: [FoldedProductSelection!]!
): PreparedPrintProductsResult! @topic(names: ["print.prepress"])
"""
Validate one composed signature carrier against captured PDFs without producing output or writing records. Managed routes require existing planning reads and file download. Sources are limited to 16 MiB each and 32 MiB combined.
"""
prepareCarrierProduct(
"""Existing source planning family and reviewed carrier arrangement."""
input: CarrierProductInput!
): CarrierProductActionResult! @topic(names: ["print.prepress"])
"""
Render one physical composed carrier through existing layout traversal, source snapshots and output-intent reconciliation. Uses impositionSpec:execute and managed planning/download permissions. Output is limited to 32 MiB; no storage or inventory writes.
"""
renderCarrierProduct(
"""
Same preparation input, optionally guarded by reviewed carrier and book source identities.
"""
input: CarrierProductInput!
): CarrierProductActionResult! @topic(names: ["print.prepress"])
"""
Preview separation without persisted production records using existing source-observed carrier preparation. No routes, graph writes or inventory are created. Existing carrier source limits apply.
"""
previewSignatureSeparation(
"""
Existing job/component or headless carrier preparation input. Existing source download and planning permissions apply.
"""
carrier: CarrierProductInput!
"""
Optional staged guillotine geometry and remnant handling. Unresolved remnants are allowed in preview.
"""
program: SignatureSeparationProgramInput
"""
Physical occurrence grouping for the prepared carrier. Geometry and identities come from the existing preparation path.
"""
blocks: [SignatureSeparationBlock!]!
): SignatureSeparationPreviewResult! @topic(names: ["print.prepress"])
"""
Validate retained separation geometry and each output's original graph route without writes or source downloads. Historical artwork is preserved.
"""
prepareSignatureSeparation(
"""
Retained carrier, cutting work and optional existing downstream route selections.
"""
input: SignatureSeparationInput!
): SignatureSeparationPreparationResult! @topic(names: ["print.prepress"])
"""
Plan rectangular roll labels through typed inputs without persistence or PDF inspection. Supports fixed lanes, bounded search, complete-repeat delivery and separate declared-limit assessments. Requires impositionSpec:read; persisted sources additionally require job:read, component:read, operation:read, substrate:read, componentArtworkFile:read and file:read.
"""
planRollLabels(
"""
Headless items or persisted job/component selection, optional overrides, production, delivery and limits with shared units.
"""
input: PlanRollLabelsInput!
): PlanRollLabelsPayload! @topic(names: ["print.prepress"])
"""
Resolve a typed roll plan and inspect its actual PDFs without rendering. Returns identities for later freshness comparison. Requires impositionSpec:read; persisted inputs also require the planning read permissions and file:download.
"""
prepareRollLabelRender(
"""
Typed planning input, headless documents when applicable and optional expected freshness identities.
"""
input: RollLabelRenderInput!
): RollLabelRenderPayload! @topic(names: ["print.prepress"])
"""
Resolve and render one roll-label repeat from typed job/component or headless inputs. Checks optional expected identities, validates actual source bytes and returns data without storage. Requires impositionSpec:execute and, for persisted sources, planning read permissions and file:download.
"""
renderRollLabels(
"""
Typed planning input, headless documents when applicable and optional expected freshness identities.
"""
input: RollLabelRenderInput!
): RollLabelRenderPayload! @topic(names: ["print.prepress"])
"""
Enumerate planned delivery rolls without PDFs or persistence. Re-resolves planning and checks identity on every continuation. Requires impositionSpec:read plus the same persisted-source/route permissions as planRollLabels; file:download is not required. Failed capability assessments remain separate from geometric planning and pagination does not authorize production release.
"""
rollLabelDeliveryPage(
"""
Retained planning input, optional bound continuation or first-page expected identity, and page size.
"""
input: RollLabelDeliveryPageInput!
): RollLabelDeliveryPagePayload! @topic(names: ["print.prepress"])
"""
Fetch a prepress operation by ID. Requires prepressOperation:read permission.
"""
getPrepressOperation(
"""Prepress operation ID"""
id: PrepressOperationID!
): PrepressOperationState @topic(names: ["print.prepress"])
"""
List prepress operations for a component. Requires prepressOperation:list permission.
"""
listPrepressOperations(
"""Component ID to list prepress operations for"""
componentId: ComponentID!
): [PrepressOperationState!]! @topic(names: ["print.prepress"])
"""
Fetch a preflight report by ID. Requires preflightReport:read permission.
"""
getPreflightReport(
"""Preflight report ID"""
id: PreflightReportID!
): PreflightReportState @topic(names: ["print.prepress"])
"""
List preflight reports for a component. Requires preflightReport:list permission.
"""
listPreflightReports(
"""Component ID to list reports for"""
componentId: ComponentID!
): [PreflightReportState!]! @topic(names: ["print.prepress"])
"""
Render a page of an artwork file to a JPEG preview (base64). Requires componentArtworkFile:read permission.
"""
renderArtworkPreview(
"""Artwork + page to render"""
input: RenderArtworkPreviewInput!
): RenderArtworkPreviewPayload! @topic(names: ["print.prepress"])
"""
Run preflight on supplied PDF bytes inline (not persisted). Requires preflightReport:read permission.
"""
preflightCheck(
"""PDF bytes + profile"""
input: PreflightCheckInput!
): PreflightCheckPayload! @topic(names: ["print.prepress"])
"""
Render a page of supplied PDF bytes to a JPEG preview (base64) inline. Requires componentArtworkFile:read permission.
"""
renderPreview(
"""PDF bytes + page"""
input: RenderPreviewInput!
): RenderArtworkPreviewPayload! @topic(names: ["print.prepress"])
"""
Render a single ink separation (plate) of an artwork page to a grayscale PNG (base64). Requires componentArtworkFile:read permission.
"""
renderPlateSeparation(
"""Artwork + separation"""
input: RenderPlateSeparationInput!
): RenderArtworkPreviewPayload! @topic(names: ["print.prepress"])
"""
Render a single ink separation (plate) from supplied PDF bytes to a grayscale PNG (base64) inline. Requires componentArtworkFile:read permission.
"""
renderSeparation(
"""PDF bytes + separation"""
input: RenderSeparationInput!
): RenderArtworkPreviewPayload! @topic(names: ["print.prepress"])
"""
Extract ISO 19593-1 production steps from supplied PDF bytes inline (not persisted) — inspect before creating Operations. Requires operation:read permission.
"""
extractProduction(
"""PDF bytes"""
input: ExtractProductionInput!
): ExtractProductionPayload! @topic(names: ["print.prepress"])
"""Fetch a substrate by ID. Requires substrate:read permission."""
getSubstrate(
"""Substrate ID to fetch"""
id: SubstrateID!
): SubstrateState @topic(names: ["print.prepress"])
"""Fetch a substrate by external ID. Requires substrate:read permission."""
getSubstrateBy(
"""External system identifier"""
externalId: String
): SubstrateState @topic(names: ["print.prepress"])
"""
List substrates with pagination and filtering. Requires substrate:list permission.
"""
listSubstrates(
"""Number of items from the start"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: SubstrateFilterInput
"""Sort order"""
sort: [SubstrateSortInput!]
): SubstrateConnection! @topic(names: ["print.prepress"])
"""
Fetch a single substrate template line by ID. Requires substrateTemplateLine:read permission.
"""
getSubstrateTemplateLine(
"""Substrate template line ID"""
id: SubstrateTemplateLineID!
): SubstrateTemplateLineState @topic(names: ["print.prepress"])
"""
List substrate template lines for a product template. Requires substrateTemplateLine:list permission.
"""
listSubstrateTemplateLines(
"""Product template to list BOM lines for"""
productTemplateId: ProductTemplateID!
): [SubstrateTemplateLineState!]! @topic(names: ["print.prepress"])
"""
Read the bridge JMF endpoint configuration for this controller. This does not enable direct POST /api/v1/jmf; that is settings.jmf (Settings › JMF signals). Requires controller:read.
"""
controllerJMFConfig(
"""Controller whose JMF config to read"""
controllerId: ControllerID!
): ControllerJMFConfigState @topic(names: ["print.jmf"])
"""
Read the JMF DeviceID set on a work center ↔ device binding. Requires workCenter:read.
"""
workCenterDeviceJMFDeviceID(
"""
TypeID (`wcd_…`) of the binding to read. Returns null when the binding has no JMF DeviceID set (or does not exist in this tenant).
"""
workCenterDeviceId: WorkCenterDeviceID!
): String @topic(names: ["print.jmf"])
"""
JSON submission history and queue identities associated with an execution record. Every id in it is a TypeID.
"""
jmfSubmissionsForTarget(
"""Exactly one operation, item or planned operation to inspect."""
input: JMFSubmissionTargetInput!
): String! @topic(names: ["print.jmf"])
"""
JSON execution observations, resolution evidence and application outcomes for a received envelope. Every id in it is a TypeID.
"""
jmfExecutionObservation(
"""Observation fingerprint from ingestion diagnostics."""
fingerprint: String!
): String @topic(names: ["print.jmf"])
"""
JSON correlation records for a queue entry, including retired attempts. Every id in it is a TypeID.
"""
jmfExecutionTargets(
"""JMF DeviceID queue namespace."""
deviceId: String!
"""QueueEntryID to inspect."""
queueEntryId: String!
): String! @topic(names: ["print.jmf"])
"""Fetch a single address by ID. Requires address:read permission."""
getAddress(
"""Address ID to fetch"""
id: AddressID!
): AddressState @topic(names: ["commerce"])
"""Fetch an address by external ID. Requires address:read permission."""
getAddressBy(
"""External system identifier (unique per tenant)"""
externalId: String
): AddressState @topic(names: ["commerce"])
"""List addresses with pagination. Requires address:list permission."""
listAddresses(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: AddressFilterInput
"""Sort order"""
sort: [AddressSortInput!]
): AddressConnection! @topic(names: ["commerce"])
"""
Fetch a single business unit by ID. Requires businessunit:read permission.
"""
getBusinessUnit(
"""Business unit ID to fetch"""
id: BusinessUnitID!
): BusinessUnitState @topic(names: ["commerce"])
"""
Fetch a business unit by external ID or code. Requires businessunit:read permission.
"""
getBusinessUnitBy(
"""External system identifier"""
externalId: String
"""Business unit code"""
code: String
): BusinessUnitState @topic(names: ["commerce"])
"""
List business units with pagination. Requires businessunit:list permission.
"""
listBusinessUnits(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: BusinessUnitFilterInput
"""Sort order"""
sort: [BusinessUnitSortInput!]
): BusinessUnitConnection! @topic(names: ["commerce"])
"""List contacts with pagination. Requires contact:list permission."""
listContacts(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: ContactFilterInput
"""Sort order"""
sort: [ContactSortInput!]
): ContactConnection! @topic(names: ["commerce"])
"""Fetch a contact by its stable ID. Requires contact:read permission."""
getContact(
"""Contact ID to fetch"""
id: ContactID!
): ContactState @topic(names: ["commerce"])
"""
Fetch a contact by external ID or email. Requires contact:read permission.
"""
getContactBy(
"""External system identifier"""
externalId: String
"""Contact email address"""
email: String
): ContactState @topic(names: ["commerce"])
"""
Fetch a single cost category by ID. Requires costcategory:read permission.
"""
getCostCategory(
"""Cost category ID to fetch"""
id: CostCategoryID!
): CostCategoryState @topic(names: ["costing"])
"""
Fetch a cost category by external ID or code. Requires costcategory:read permission.
"""
getCostCategoryBy(
"""External system identifier"""
externalId: String
"""Cost category code"""
code: String
): CostCategoryState @topic(names: ["costing"]) @topic_example(names: ["erp.find-cost-category"])
"""
List cost categories with pagination. Requires costcategory:list permission.
"""
listCostCategories(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: CostCategoryFilterInput
"""Sort order"""
sort: [CostCategorySortInput!]
): CostCategoryConnection! @topic(names: ["costing"])
"""Fetch a single cost center by ID. Requires costcenter:read permission."""
getCostCenter(
"""Cost center ID to fetch"""
id: CostCenterID!
): CostCenterState @topic(names: ["commerce"])
"""
Fetch a cost center by external ID or code. Requires costcenter:read permission.
"""
getCostCenterBy(
"""External system identifier"""
externalId: String
"""Cost center code"""
code: String
): CostCenterState @topic(names: ["commerce"])
"""
List cost centers with pagination. Requires costcenter:list permission.
"""
listCostCenters(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: CostCenterFilterInput
"""Sort order"""
sort: [CostCenterSortInput!]
): CostCenterConnection! @topic(names: ["commerce"])
"""Fetch a single cost rate by ID. Requires costrate:read permission."""
getCostRate(
"""Cost rate ID to fetch"""
id: CostRateID!
): CostRateState @topic(names: ["costing"])
"""List cost rates with pagination. Requires costrate:list permission."""
listCostRates(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: CostRateFilterInput
"""Sort order"""
sort: [CostRateSortInput!]
): CostRateConnection! @topic(names: ["costing"])
"""Fetch a single customer by ID. Requires customer:read permission."""
getCustomer(
"""Customer ID to fetch"""
id: CustomerID!
): CustomerState @topic(names: ["commerce"]) @topic_example(names: ["crm.read-customer-overview"])
"""Fetch a customer by external ID. Requires customer:read permission."""
getCustomerBy(
"""External system identifier"""
externalId: String
): CustomerState @topic(names: ["commerce"]) @topic_example(names: ["crm.find-customer"])
"""
List customers with pagination, filtering, and sorting. Requires customer:list permission.
"""
listCustomers(
"""Number of items to return from the start (forward pagination)"""
first: Int
"""Number of items to return from the end (backward pagination)"""
last: Int
"""Cursor pointing to the item after which to start"""
after: String
"""Cursor pointing to the item before which to start"""
before: String
"""Filter criteria for customers"""
filter: CustomerFilterInput
"""Sort order for results"""
sort: [CustomerSortInput!]
): CustomerConnection! @topic(names: ["commerce"]) @topic_example(names: ["crm.browse-customers"])
"""
List customer price overrides. Requires customerPriceOverride:list permission.
"""
listCustomerPriceOverrides(
"""
Maximum number of overrides to return. Defaults to 25 when omitted; values above 100 are rejected.
"""
first: Int
"""
Cursor to page after, taken from a previous page's `endCursor`. The listing resumes at the override following that cursor, under the same `filter` and `sort`.
"""
after: String
"""
Optional filter criteria. When omitted, all overrides in the tenant are listed.
"""
filter: CustomerPriceOverrideFilterInput
"""
Sort keys applied to the result set before paging. When omitted, overrides are ordered by creation date, newest first.
"""
sort: [CustomerPriceOverrideSortInput!]
last: Int
before: String
): CustomerPriceOverrideConnection! @topic(names: ["commerce"])
"""
Fetch a single operation cost mapping by ID. Requires costcategory:read permission.
"""
getOperationCostMapping(
"""Operation cost mapping ID to fetch"""
id: OperationCostMappingID!
): OperationCostMappingState @topic(names: ["costing"])
"""List operation cost mappings. Requires costcategory:list permission."""
listOperationCostMappings(
"""
Maximum number of mappings to return. Defaults to 25 when omitted; values above 100 are rejected.
"""
first: Int
"""
Cursor from a previous page's `pageInfo.endCursor`. The listing resumes at the mapping following that cursor, under the same `filter` and `sort`.
"""
after: String
"""
Optional filter criteria; when omitted all of the tenant's mappings match.
"""
filter: OperationCostMappingFilterInput
"""
Ordering terms. When omitted, mappings are ordered by creation date, newest first.
"""
sort: [OperationCostMappingSortInput!]
last: Int
before: String
): OperationCostMappingConnection! @topic(names: ["costing"])
"""
Fetch a single price bracket by ID. Requires priceBracket:read permission.
"""
getPriceBracket(
"""Price bracket ID"""
id: PriceBracketID!
): PriceBracketState @topic(names: ["commerce"])
"""
List price brackets with pagination. Requires priceBracket:list permission.
"""
listPriceBrackets(
"""Number of items to return"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: PriceBracketFilterInput
"""Sort order"""
sort: [PriceBracketSortInput!]
last: Int
before: String
): PriceBracketConnection! @topic(names: ["commerce"])
"""
Fetch a single production cell by id, scoped to the caller's tenant. Null when no such production cell exists. Requires productionCell:read permission.
"""
getProductionCell(
"""TypeID (prefix "pcl") of the production cell to fetch."""
id: ProductionCellID!
): ProductionCellState @topic(names: ["jobs"])
"""
List the tenant's production cells as a paginated connection, with optional filtering and sorting. Requires productionCell:list permission.
"""
listProductionCells(
"""
Return the first N production cells after the cursor (forward pagination).
"""
first: Int
"""
Return the last N production cells before the cursor (backward pagination).
"""
last: Int
"""Opaque cursor from a previous page's edge; results start after it."""
after: String
"""Opaque cursor from a previous page's edge; results end before it."""
before: String
"""
Criteria narrowing which production cells are returned; omit for all of them.
"""
filter: ProductionCellFilterInput
"""
Ordering terms, applied in order. Defaults to createdAt descending; all terms participate in keyset pagination.
"""
sort: [ProductionCellSortInput!]
): ProductionCellConnection! @topic(names: ["jobs"])
"""
Fetch a single recorded cost by ID. Requires recordedcost:read permission.
"""
getRecordedCost(
"""Recorded cost ID to fetch"""
id: RecordedCostID!
): RecordedCostState @topic(names: ["costing"])
"""
List recorded costs with pagination. Requires recordedcost:list permission.
"""
listRecordedCosts(
"""Number of items from the start"""
first: Int
"""Number of items from the end"""
last: Int
"""Cursor to start after"""
after: String
"""Cursor to start before"""
before: String
"""Filter criteria"""
filter: RecordedCostFilterInput
"""Sort order"""
sort: [RecordedCostSortInput!]
): RecordedCostConnection! @topic(names: ["costing"]) @topic_example(names: ["erp.browse-job-costs"])
"""Fetch a single tax code by ID. Requires taxCode:read permission."""
getTaxCode(
"""Tax code ID"""
id: TaxCodeID!
): TaxCodeState @topic(names: ["commerce"])
"""List tax codes with pagination. Requires taxCode:list permission."""
listTaxCodes(
"""Number of items to return"""
first: Int
"""Cursor to start after"""
after: String
"""Filter criteria"""
filter: TaxCodeFilterInput
"""Sort order"""
sort: [TaxCodeSortInput!]
last: Int
before: String
): TaxCodeConnection! @topic(names: ["commerce"])
}