Mutation
Fields
Register or update an integration's identity without changing record origin or IaC management.
Arguments (1)
Identity to register for one existing record.
Saves the units section. Other sections are untouched.
Arguments (1)
The new unit settings.
Saves the time section. Other sections are untouched.
Arguments (1)
The new time settings.
Saves the production board section. Other sections are untouched.
Arguments (1)
The new production board settings.
Saves the app access section. Other sections are untouched.
Arguments (1)
The new app access settings.
Saves the status rules section. Other sections are untouched.
Arguments (1)
The new status rule settings.
Saves the tool invocations section. Other sections are untouched.
Arguments (1)
The new tool invocation settings.
Saves the time tracking section: the labour cost category logged time is costed in. Other sections are untouched; existing entries are never re-costed.
Arguments (1)
The new time tracking settings.
Saves the quoting section. Other sections are untouched.
Arguments (1)
The new quoting settings.
Saves the machine-learning section. Other sections are untouched.
Arguments (1)
The new machine-learning settings.
Saves the ML experiment retention section. Other sections are untouched. A lower value applies to existing runs and experiments within the hour and cannot be undone.
Arguments (1)
The new ML experiment retention settings.
Append a plain text comment to a proposed or applied Change Request. Retry the same id and body after a lost response.
Arguments (4)
Owning stack.
Change Request being discussed.
Client-generated comment id (cmt_…); reuse it to retry safely.
Plain-text comment, 1 to 16 KiB.
Immediately delete a working branch with expected-head protection.
Stage immutable objects without changing branch refs or deployed configuration.
Arguments (2)
Owning stack.
Hash-verified immutable objects; at most 1 MiB decoded per batch.
Compare and update a working branch; never publishes main or applies configuration.
Rename a draft proposal without altering source, state, or approval. Requires stack authoring access.
Arguments (4)
Owning stack.
Draft Change Request to rename.
New title, at most 255 UTF-8 bytes.
Previously read title; protects concurrent edits.
Replace a draft Change Request's description. Only its author may do this.
Arguments (4)
Owning stack.
Draft Change Request whose description changes.
New description, at most 64 KiB; may be empty.
Previously read description; protects concurrent edits.
Close a draft Change Request without applying it. Allowed for its author and for anyone who may apply the stack; the conversation stays readable.
Arguments (2)
Owning stack.
Draft Change Request to cancel.
Capture an immutable draft Change Request; no client-supplied plan is trusted or applied.
Arguments (7)
Owning stack.
Short title of the proposed change; required.
Optional explanation of why the change is needed, at most 64 KiB.
Working branch to capture.
Expected source commit, preventing accidental capture of newer edits.
Require main to match expectedMain atomically; true with null expectedMain requires an empty repository.
Expected main commit when checkExpectedMain is true.
Capture the Change Request branch's pushed head as its next revision, keeping the conversation. Returns the Change Request unchanged when the branch has no new commits.
Arguments (3)
Owning stack.
Draft Change Request to revise.
The revision the caller last saw; a different current revision is refused with REVISION_CHANGED.
Privately prepare an exact plan without publishing source or creating a change. Expires after 30 minutes; only its creator may publish it.
Arguments (8)
Owning stack.
Private immutable source objects, commit and expected base as JSON.
Existing review to revise only when this preparation is published.
Expected current revision of the existing review.
Description used only when this preparation is published.
Optional review context.
Optional repository-relative project target.
Bypass immutable content caches for this plan and its apply recheck.
Publish a confirmed preparation as a change request and reviewed plan. Repeating publication returns the same change; stack review rules still gate apply.
Produce a trusted server plan without applying resources.
Arguments (5)
Owning stack.
Immutable Change Request to plan.
Optional repository-relative target; otherwise use the project manifest.
Bypass immutable content caches for this plan and its apply recheck.
Private variable source, encrypted with the plan and never committed to Git.
Atomically Apply the reviewed plan as the actual user, publishing main only on success. The stack's rules must be met (REVIEW_REQUIRED, CHANGES_REQUESTED) unless a stack admin bypasses them.
Arguments (4)
Owning stack.
Server-produced plan reviewed by this user.
Exact digest approved by this user; stale plans fail closed.
Apply without meeting the stack's rules, recording this reason (at most 2 KiB). Only stack admins, and only when the rules allow bypass (otherwise BYPASS_NOT_ALLOWED). A blank reason is no bypass.
Coordinator-only state capability; unavailable to ordinary clients.
Update authoring presence without changing source or deployment state.
End an authoring presence session.
Arguments (2)
Stack id (stk_…).
Editing session to leave.
Atomically create an absent stack and import legacy state. Requires tenant administration; exact retries are idempotent.
Create a hosted Git stack.
Arguments (4)
Deployment environment assertion.
Unique stack name.
Human-readable stack name.
Owning team; unassigned stacks require tenant administration.
Configure stack ownership and archival under stack administration permissions.
Arguments (4)
Stack id (stk_…).
New owning team.
Whether the stack is read-only.
Explicitly remove the owning team.
Manage stack grants; grants never bypass resource permissions.
Write a new version of a stack secret; earlier versions are kept. Plans made before it need re-planning. Requires stack administration.
Mark a stack secret deleted by writing a deleted version; earlier versions are kept for audit. True when the secret was deleted. Requires stack administration.
Irreversibly destroy stored secret values, for example after a leak. Metadata stays; plans that used a purged version must be re-planned. Requires stack administration.
Seed a stack's non-sensitive values once, when it has none (otherwise VALUES_EXIST); every later change is a reviewed values change. Requires stack administration.
Arguments (2)
Owning stack.
Non-sensitive values to seed, each name once.
Propose new stack values as a values change: a Change Request on refs/cococo/values that plans main's source with the proposed values and is reviewed, gated and applied like any change. One open values change per stack (CHANGE_EXISTS). Secrets are refused with VALUE_SENSITIVITY_MISMATCH.
Arguments (4)
Owning stack; it must have a main (an applied change).
Short title of the values change; required, one line, at most 255 bytes.
Values to set, each name once.
Names whose current value the change removes.
Change a stack's rules. Every change is recorded. Requires stack administration; invalid values are refused with INVALID_RULES.
Arguments (6)
Stack whose rules change.
Approvals required, 0 to 10; omitted leaves it unchanged.
Count only owning-team approvals; needs an owning team. Omitted leaves it unchanged.
Dismiss approvals when a revision changes content; omitted leaves it unchanged.
Let stack admins apply without meeting the rules; omitted leaves it unchanged.
The updatedAt last read; omit when no rules were set. A different current value is refused with RULES_CHANGED.
Give a verdict on the current revision; it replaces your earlier verdict on that revision. The Change Request's author and anyone who captured a revision cannot approve (SELF_APPROVAL). Requires stack write access.
Arguments (5)
Owning stack.
Draft Change Request to review.
The revision reviewed; anything but the current revision is refused with REVISION_CHANGED.
Approve, or request changes.
Possible values (2)
APPROVEThe reviewer approves the revision.
REQUEST_CHANGESThe reviewer asks for changes; this blocks apply until withdrawn, dismissed or replaced by an approval.
Optional plain-text note, up to 16 KiB, shown in the timeline.
Withdraw your own review, or, as a stack admin, dismiss someone else's with a reason. Recorded in the timeline.
Arguments (3)
Owning stack.
Review to dismiss.
Why; required when dismissing someone else's review.
Create or update a job. Requires job:write permission.
Arguments (1)
Job data
Create a new job. Requires job:write permission.
Arguments (1)
Job data
Update a job. Only provided fields are changed. Requires job:write permission.
Arguments (2)
Job ID to update
Fields to update — only provided fields are changed
Delete a job. Requires job:delete permission.
Arguments (1)
Job to delete
Atomically replace or clear a job assembly graph. Validates job membership, cycles, containers and sibling precedence. Requires job:write, job:read and component:read. Inferred edges are saved only when explicitly supplied by the caller.
Arguments (1)
Whole explicit graph, ordered list or nested members, plus the expected graph revision.
Create a new job group. Requires jobGroup:write permission.
Arguments (1)
Job group data
Add a new job to a group by instantiating the group's template. Requires jobGroup:write permission.
Arguments (1)
Job to add
Remove a job from its group (job survives). Requires jobGroup:write permission.
Arguments (1)
Job to remove
Delete a job group (jobs are unlinked, not deleted). Requires jobGroup:delete permission.
Arguments (1)
Job group to destroy
Delete a job group and all its jobs. Requires jobGroup:delete permission.
Arguments (1)
Job group to destroy with all jobs
Create a batch; validates tenant, scope and references
Arguments (1)
Record fields
Update a batch; validates tenant, scope and references
Delete a batch; validates tenant, scope and references
Arguments (1)
Identifier to delete
Create a batchComponent; validates tenant, scope and references
Arguments (1)
Record fields
Update a batchComponent; validates tenant, scope and references
Arguments (2)
Identifier to update
Record fields
Delete a batchComponent; validates tenant, scope and references
Arguments (1)
Identifier to delete
Create a batchContribution; validates tenant, scope and references
Arguments (1)
Record fields
Update a batchContribution; validates tenant, scope and references
Arguments (2)
Identifier to update
Record fields
Delete a batchContribution; validates tenant, scope and references
Arguments (1)
Identifier to delete
Delegate job work to batch component work, or clear an unexecuted assignment.
Arguments (1)
Original work and its batch producer.
Complete delegated job work from finished producer evidence without duplicate machine metrics or production receipts.
Arguments (1)
Source-specific full fulfilment confirmation.
Create or update a product template. Requires productTemplate:write permission.
Arguments (1)
Template data
Create a new product template. Requires productTemplate:write permission.
Arguments (1)
Template data
Update a product template. Only provided fields are changed. Requires productTemplate:write permission.
Arguments (2)
Product template ID to update
Fields to update — only provided fields are changed
Delete a product template. Requires productTemplate:delete permission.
Arguments (1)
Template to delete
Publish a product template version. Requires productTemplate:write permission.
Arguments (1)
Template to publish
Create or update a milestone. Requires milestone:write permission.
Arguments (1)
Milestone data
Create a new milestone. Requires milestone:write permission.
Arguments (1)
Milestone data
Update a milestone. Only provided fields are changed. Requires milestone:write permission.
Arguments (2)
Milestone ID to update
Fields to update — only provided fields are changed
Mark a milestone as started now. Does not change its completion. Requires milestone:write permission.
Arguments (1)
Milestone to start
Clear a milestone's start. Requires milestone:write permission.
Arguments (1)
Milestone to unstart
Mark a milestone as completed. Requires milestone:write permission.
Arguments (1)
Milestone to complete
Mark a milestone as not completed. Requires milestone:write permission.
Arguments (1)
Milestone to uncomplete
Mark a milestone as cancelled, optionally recording a reason. Requires milestone:write permission.
Arguments (1)
Milestone to cancel, with optional reason
Clear the cancellation state of a milestone. Requires milestone:write permission.
Arguments (1)
Milestone to uncancel
Delete a milestone. Requires milestone:delete permission.
Arguments (1)
Milestone to delete
Create or update a component. Requires component:write permission.
Arguments (1)
Component data
Create a new component. Requires component:write permission.
Arguments (1)
Component data
Update a component. Only provided fields are changed. Requires component:write permission.
Arguments (2)
Component ID to update
Fields to update — only provided fields are changed
Delete a component. Requires component:delete permission.
Arguments (1)
Component to delete
Create or update a component section. Requires componentGroup:write permission.
Arguments (1)
Component section data
Create a new component section. Requires componentGroup:write permission.
Arguments (1)
Component section data
Update a component section. Only provided fields are changed. Requires componentGroup:write permission.
Arguments (2)
Component section ID to update
Fields to update — only provided fields are changed
Delete a component section. Requires componentGroup:delete permission.
Arguments (1)
Component section to delete
Create or update an operation. Requires operation:write permission.
Arguments (1)
Operation data
Create a new operation. Requires operation:write permission.
Arguments (1)
Operation data
Update an operation. Only provided fields are changed. Requires operation:write permission.
Arguments (2)
Operation ID to update
Fields to update — only provided fields are changed
Transition operation to a new status. Requires operation:execute permission.
Arguments (1)
Operation and target status
Delete an operation. Requires operation:delete permission.
Arguments (1)
Operation to delete
Create or update a script. Requires script:write permission.
Arguments (1)
Script data
Create a new script. Requires script:write permission.
Arguments (1)
Script data
Update a script. Only provided fields are changed. Requires script:write permission.
Arguments (2)
Script ID to update
Fields to update — only provided fields are changed
Put an old version's source back on the script. Appends a new version rather than rewinding history. The name and role are not restored, only the source. Requires script:write permission.
Delete a script. Requires script:delete permission.
Create or update a service account. Only BOT accounts are writable through the API — HUMAN users are provisioned by Control and are read-only here. Requires user:write permission.
Arguments (1)
User data
Create a new service account. The created user is always a BOT — HUMAN users are provisioned by Control. Requires user:write permission.
Arguments (1)
User data
Update a service account. Only provided fields are changed. HUMAN accounts are provisioned by Control and cannot be updated. Requires user:write permission.
Arguments (2)
User ID to update
Fields to update — only provided fields are changed
Delete a service account. HUMAN accounts are provisioned by Control and cannot be deleted here. Requires user:delete permission.
Attach a conditional policy for IaC ownership; an existing attachment must be imported.
Arguments (1)
User and policy to attach
Attach a policy for IaC ownership; an existing attachment must be imported.
Arguments (1)
User and policy to attach
Detach the policy without deleting its user or policy.
Arguments (1)
Policy attachment identifier
Create an IAM policy and return its revision. Requires iam:createPolicy permission.
Arguments (1)
Policy data
Update an IAM policy, refusing the change if it was edited since expectedRevision. Requires iam:updatePolicy permission.
Arguments (2)
IAM policy ID to update
Policy update data; expectedRevision is required
Create an IAM policy. Requires iam:createPolicy permission.
Arguments (1)
Policy data
Update an IAM policy. Requires iam:updatePolicy permission.
Arguments (2)
IAM policy ID to update
Policy update data
Delete an IAM policy. Requires iam:deletePolicy permission.
Arguments (1)
Policy ID to delete
Attach a policy to a user. Requires iam:attachPolicy permission.
Arguments (1)
Attachment data
Detach a policy from a user. Requires iam:detachPolicy permission.
Arguments (1)
Detachment data
Create a new workflow. Requires workflow:write permission.
Arguments (1)
Workflow data
Update an existing workflow. Requires workflow:write permission.
Arguments (2)
Workflow ID to update
Workflow update data
Delete a workflow and all its versions. Requires workflow:delete permission.
Arguments (1)
Workflow ID to delete
Delete one version from a workflow's authoring history. Fails when the workflow is active and this is the version it runs — deactivate it or activate another version first. Requires workflow:delete permission.
Arguments (1)
TypeID of the workflow version to delete.
Idempotent workflow version cleanup; retains the active-version protection
Arguments (1)
Version to remove, or confirm already removed by parent deletion
Create an immutable workflow version from XML; validation is shared with all authoring paths. Does not activate it.
Arguments (1)
Parent workflow and XML source to compile, validate and save as a new version
Create a new version of a workflow. Requires workflow:write permission.
Arguments (1)
Version data
Set the active version of a workflow. Requires workflow:write permission.
Arguments (2)
Workflow ID
Version ID to set as active (null to unset)
Export a workflow version to YAML or JSON. Requires workflow:read permission.
Arguments (1)
Export parameters
Import a workflow from YAML or JSON, creating a new version. Requires workflow:write permission.
Arguments (1)
Import parameters
Validate a workflow definition without importing it. Requires workflow:read permission.
Arguments (1)
Validation parameters
Delete a journey version using native authorization, succeeding when it is already absent for parent-owned cascade cleanup.
Arguments (1)
Journey version to remove; absence is treated as successful idempotent cleanup.
Compile authoritative Journey XML and create a journey using native scope-dependent authorization.
Arguments (1)
Journey XML plus optional visibility and team assignments to validate and create.
Apply a revision-checked Journey XML or visibility edit while preserving fields omitted by the caller.
Arguments (2)
Existing journey to edit within the current tenant.
Observed revision and replacement source, scope or teams; omitted optional edits are retained.
Compile Journey XML into a new draft version under an existing journey, preserving prior versions.
Arguments (1)
Parent journey and authoritative XML for the new draft version.
Create a journey or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
Arguments (1)
The journey document plus its scope and team assignments. The definition's id (the handle) selects the journey to edit, or creates one if no journey in the tenant carries that handle.
Create a new journey. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
Arguments (1)
The journey document plus its scope and team assignments. Always creates a new journey with a single draft version; it never edits an existing one.
Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.
Arguments (2)
TypeID of the journey to patch (prefix jny). This, not the definition's handle, identifies the record; the handle is never reassigned.
The aspects to change. Omitted fields leave the journey untouched.
Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.
Arguments (2)
TypeID of the journey to publish (prefix jny).
TypeID of the draft version to promote (prefix jnv). Fails with a field error when the version is unknown, belongs to another journey, or is not an open draft.
Create a new draft version of a journey. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else journey:write.
Arguments (1)
The journey to extend and the definition for its new draft.
Delete one version from a journey's authoring history. Fails when the version is the one the journey is currently published at — delete the journey itself to remove that. Owner for PERSONAL, else journey:write.
Arguments (1)
TypeID of the journey version to delete (prefix jnv).
Delete a journey and all its versions. Owner for PERSONAL, else journey:write.
Create a workspace or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
Arguments (1)
The definition (which carries the handle) plus optional scope / team assignments.
Create a new workspace. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
Arguments (1)
The definition for the new workspace plus optional scope / team assignments.
Revision-checked Workspace authoring update using native authorization and validation.
Arguments (2)
Existing workspace whose authoring source or assignments will be edited.
Observed revision and author-owned source or visibility edits, validated using native Workspace rules.
Update a workspace. Only provided fields are changed. Owner for PERSONAL, else workspace:write.
Arguments (2)
TypeID of the workspace to update (prefix wks).
Patch of the fields to change; omitted fields are left untouched.
Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.
Promote a named draft version of a workspace to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else workspace:write.
Arguments (2)
TypeID of the workspace to publish (prefix wks).
TypeID of the draft version to promote (prefix wsv). Fails with a field error when the version is unknown, belongs to another workspace, or is not an open draft.
Create an immutable source snapshot for reviewed publication. Parent edits create another draft instead of changing this version. Uses native Workspace authorization and validation.
Arguments (1)
Parent workspace and reviewed source snapshot to persist as a new immutable draft version.
Create a new draft version of a workspace. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else workspace:write.
Arguments (1)
The workspace to extend and the definition for its new draft.
Idempotent cleanup retaining native scope authorization and published-version protection
Arguments (1)
Version to remove or confirm already removed by parent deletion
Delete one version from a workspace's authoring history. Fails when the version is the one the workspace is currently published at — delete the workspace itself to remove that. Owner for PERSONAL, else workspace:write.
Arguments (1)
TypeID of the workspace version to delete (prefix wsv).
Delete a workspace and all its versions. Owner for PERSONAL, else workspace:write.
Arguments (1)
TypeID of the workspace to delete (prefix wks). Its versions and team assignments cascade.
Create a Portal. Control allocates its generated address; retrying with the same idempotencyKey returns the same Portal.
Arguments (1)
Configuration of the new Portal.
Update a Portal's configuration. Omitted input fields keep their values.
Delete a Portal with its sites, snapshots and Portal-scoped identity records. Tenant-wide PortalUsers are kept; deleting a missing Portal succeeds.
Replace a Portal's audience bindings, which choose the site each kind of visitor is served.
Arguments (3)
Portal whose bindings to replace.
Complete replacement list; [] removes every binding.
Optional stale-write check. Omit for standard atomic publication/binding semantics.
Reserve a custom hostname for a Portal. Returns an expiring exclusive DNS TXT proof to publish before verifying.
Arguments (2)
Portal the alias is for.
Hostname and retry key of the reservation.
Ask Control to check a reserved alias's TXT proof and, when it matches, begin HTTP-01 TLS issuance.
Arguments (2)
Portal the alias belongs to.
The pdm_ reservation id returned by reservePortalDomain; a bare UUID is refused.
Read a custom alias's current status from Control and update the locally cached status. Changes no Portal configuration.
Arguments (2)
Portal the alias belongs to.
The pdm_ reservation id returned by reservePortalDomain; a bare UUID is refused.
Create an empty site for a Portal. Publish a source version to make it servable.
Arguments (1)
The new site.
Update a site's settings. Omitted input fields keep their values.
Arguments (2)
Site to update.
Fields to change.
Delete a site and its snapshots. Fails with CONFLICT while an audience binding still references it; deleting a missing site succeeds.
Arguments (1)
Site to delete.
Store a new immutable source snapshot for a site. Each call creates an independent snapshot, even for identical source.
Arguments (1)
Site and complete source files of the snapshot.
Delete an unpublished source snapshot. The published snapshot cannot be deleted; deleting a missing one succeeds.
Arguments (1)
Snapshot to delete.
Make a snapshot the site's served version and increment the site revision. Publishing an older snapshot rolls back.
Arguments (3)
Site to publish.
Snapshot of that site to serve.
Optional stale-write check. Omit for standard atomic publication/binding semantics.
Create a tenant-wide PortalUser. Admit them to a Portal with createPortalMembership.
Arguments (1)
The new user.
Update a PortalUser. Omitted input fields keep their values; deactivation stops their authentication immediately.
Arguments (2)
PortalUser to update.
Fields to change.
Revoke a PortalUser, immediately disabling their sessions and credentials. The record is kept for audit, not deleted.
Arguments (1)
PortalUser to revoke.
Admit a PortalUser to a Portal on behalf of a customer.
Arguments (1)
The new membership.
Update a membership's roles, policy grants or activity. Changes apply to subsequent requests without reissuing credentials.
Arguments (2)
Membership to update.
Fields to change.
Revoke a membership, immediately disabling credentials that act through it. The record is kept for audit, not deleted.
Arguments (1)
Membership to revoke.
Issue a bearer API credential for a membership. The secret is returned only in this response.
Arguments (1)
Membership, lifetime and optional restrictions of the credential.
Revoke an API credential so it no longer authenticates. The record is kept for audit, not deleted.
Arguments (1)
Credential to revoke.
Issue a single-use login ticket that starts a Portal browser session. The secret is returned only in this response.
Arguments (1)
Target, lifetime and optional restrictions of the ticket.
Revoke an unredeemed login ticket so it can no longer start a session. The record is kept for audit, not deleted.
Arguments (1)
Ticket to revoke.
Create a tool definition. Requires mcpTool:write.
Arguments (1)
Authored fields and assignments. Set published to true for atomic publication.
Upsert a tool definition. Requires mcpTool:write.
Arguments (1)
Authored fields and assignments. Set published to true for atomic publication.
Update a tool definition. Requires mcpTool:write.
Arguments (2)
Tool identity.
Authored fields and assignments. Set published to true for atomic publication.
Analyze and publish the current draft atomically.
Arguments (2)
Tool identity.
Exact revision to publish.
Delete a tool and its versions and assignments.
Run an assigned tool as the caller and record the run. Any signed-in user; assignment is the grant. The tool's effects are real and are not rolled back.
Arguments (4)
Tool to run; must be assigned to the caller, enabled and published.
Published version the request was prepared against; a newer one refuses the run.
Arguments; must match the tool's input schema.
1–200 characters chosen by the caller per request; repeating it returns the first invocation without running again.
Run the current draft as the authenticated developer; also requires mcpTool:read.
Declare an integration before any version exists. Requires integration:write permission.
Arguments (1)
The integration to declare
Make a version the integration's current version — the default for new installs. Existing instances are never moved. Requires integration:write permission.
Arguments (2)
TypeID of the integration (prefix igr)
TypeID of the version to make current (prefix igd). A DRAFT is validated and promoted to ACTIVE; an ACTIVE version is a rollback or roll-forward; DEPRECATED is refused.
Delete an integration that has no versions. Requires integration:delete permission.
Arguments (1)
TypeID of the integration to delete (prefix igr)
Validate a journey definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires journey:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
Arguments (1)
Journey definition JSON document to validate.
Validate a workspace definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires workspace:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
Arguments (1)
Workspace definition JSON document to validate.
Create a new workflow trigger
Arguments (1)
Workflow, name and type-tagged configuration for the trigger to create.
Update an existing workflow trigger
Arguments (2)
Workflow trigger ID to update
The fields to change; omitted fields are left unchanged.
Delete a workflow trigger
Arguments (1)
Identifies the trigger to delete. The payload returns the trigger as it looked immediately before deletion.
Enable a workflow trigger
Arguments (1)
Identifies the trigger to arm; sets isEnabled to true.
Disable a workflow trigger
Arguments (1)
Identifies the trigger to disarm; sets isEnabled to false without deleting it.
Start a new workflow execution. Requires workflow:execute permission.
Arguments (1)
Execution parameters
Cancel a running workflow execution. Requires workflow:execute permission.
Arguments (1)
Execution ID to cancel
Resume a workflow execution that is waiting for an external signal. Requires workflow:execute permission.
Arguments (1)
Execution ID to resume
Record authenticated, audited evidence that the exact predecessor process has terminated before workflow recovery. Requires workflow:reconcileRuntime permission.
Arguments (9)
Execution ID whose predecessor is being reconciled
Observed run-generation fencing token
Observed process-incarnation fencing token
Observed exact runtime claim identity
Observed durable supervisor authority token
Observed durable supervisor revision
Observed legacy execution status, when reconciling a pre-upgrade row
Observed short-lived row freshness token for a pre-upgrade row
Audited evidence that the exact predecessor process has terminated
Resolve the best-effort JSON Schema for a node's output given its config — SwiftLua-inferred for script-backed kinds, falling back to the kind's static declared schema. Requires workflow:read permission.
Arguments (1)
Node type + config to resolve
Create or update a dashboard. Requires dashboard:write permission.
Arguments (1)
Dashboard data
Create a new dashboard. Requires dashboard:write permission.
Arguments (1)
Dashboard data
Update a dashboard. Only provided fields are changed. Requires dashboard:write permission.
Arguments (2)
Dashboard ID to update
Fields to update — only provided fields are changed
Delete a dashboard and all its cards. Requires dashboard:delete permission.
Arguments (1)
ID of the dashboard to delete
Create a card on a dashboard. Only the dashboard owner may. Requires dashboard:write permission.
Arguments (1)
Card data
Update a dashboard card in place. Only the dashboard owner may. Requires dashboard:write permission.
Arguments (3)
Card ID to update
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.
Fields to update — only provided fields are changed
Create or update a card within a dashboard. Requires dashboard:write permission.
Arguments (1)
Card data
Delete a card from a dashboard. Requires dashboard:write permission.
Arguments (2)
Card ID to delete
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.
Bulk update card positions after drag/resize operations. Requires dashboard:write permission.
Arguments (1)
Layout update data
Export a dashboard and its cards to YAML or JSON. Requires dashboard:read permission.
Arguments (1)
Export parameters
Import a dashboard from YAML or JSON, creating a new dashboard. Requires dashboard:write permission.
Arguments (1)
Import parameters
Create or update a custom app. Requires customapp:write permission.
Arguments (1)
Custom app data
Create a new custom app. Requires customapp:write permission.
Arguments (1)
Custom app data
Update a custom app. Only provided fields are changed. Requires customapp:write permission.
Arguments (2)
Custom app ID to update
Fields to update — only provided fields are changed
Delete a custom app. Requires customapp:delete permission.
Arguments (1)
ID of the custom app to delete
Create a session token for a custom app. The token should be passed in the X-App-Session header for RPC calls. Open to anyone who can see the app: customapp:read holders by the usual visibility rule, and other signed-in users for a published app assigned to them directly or through a team (as customAppView). Previewing a version needs customapp:read.
Arguments (1)
Session creation input
Publish a specific version of a custom app, making it visible to end users. Requires customapp:write permission.
Arguments (2)
TypeID of the custom app to publish (prefix cap).
TypeID of the version to make live (prefix cav). Fails with a field error when the version is unknown or belongs to another app. Its content and engine version are copied onto the app — this is what makes it serve.
Upgrade a custom app's engine to v2 after a script-shape lint. Requires customapp:write permission.
Arguments (1)
Engine-version upgrade input
Open an in-memory preview of a custom app's draft server API for the caller. Nothing is saved; the preview ends after a period without calls. Source with problems still opens a preview, which holds no server API until fixed. Requires customapp:write.
Arguments (1)
The draft to preview.
Push a draft's current server API to its preview. Source with problems is not taken: the last working source keeps running and the problems are returned. Only the person who opened the preview may update it. Requires customapp:write.
Arguments (2)
TypeID of the preview (prefix dpv).
The draft's current state; appId must be the one the preview was opened with.
End a draft preview now rather than at its idle timeout. Only the person who opened it may close it. Requires customapp:write.
Attach a user to a custom app. Requires customappuser:write permission.
Arguments (1)
Attachment data
Detach a user from a custom app. Requires customappuser:write permission.
Arguments (1)
Detachment data
Attach a team to a custom app. Requires customappteam:write permission.
Arguments (1)
Attachment data
Detach a team from a custom app. Requires customappteam:write permission.
Arguments (1)
Detachment data
Create a new version snapshot of a custom app. Requires customapp:write permission.
Arguments (1)
Version creation input
Delete a custom app version. Requires customapp:delete permission.
Arguments (1)
ID of the version to delete
Create or update a custom data container. Requires customapp:write permission.
Arguments (1)
Container data
Create a custom data container. Requires customapp:write permission.
Arguments (1)
Container data
Update a custom data container. Only provided fields are changed. Requires customapp:write permission.
Arguments (2)
Container ID to update
Fields to update — only provided fields are changed
Delete a custom data container. Requires customapp:delete permission.
Arguments (1)
Delete input
Create or update a data schema. Requires dataschema:write permission.
Arguments (1)
Schema data
Create a new data schema. Requires dataschema:write permission.
Arguments (1)
Schema data
Update a data schema. Only provided fields are changed. Requires dataschema:write permission.
Arguments (2)
Data schema ID to update
Fields to update — only provided fields are changed
Delete a data schema. Requires dataschema:delete permission.
Arguments (1)
Delete input
Create or update a data record. Requires datarecord:write permission.
Arguments (1)
Record data
Create a new data record. Requires datarecord:write permission.
Arguments (1)
Record data
Update a data record. Only provided fields are changed. Requires datarecord:write permission.
Arguments (2)
Data record ID to update
Fields to update — only provided fields are changed
Delete a data record. Requires datarecord:delete permission.
Arguments (1)
Delete input
Create or update a protobuf schema. Requires protobufSchema:write permission.
Arguments (1)
Schema data
Create a new protobuf schema. Requires protobufSchema:write permission.
Arguments (1)
Schema data
Update a protobuf schema. Only provided fields are changed. Requires protobufSchema:write permission.
Arguments (2)
Protobuf schema ID to update
Fields to update — only provided fields are changed
Delete a protobuf schema. Requires protobufSchema:delete permission.
Arguments (1)
Delete input
Create or update a network. Requires network:write permission.
Arguments (1)
Network data
Create a new network. Requires network:write permission.
Arguments (1)
Network data
Update a network. Only provided fields are changed. Requires network:write permission.
Arguments (2)
Network ID to update
Fields to update — only provided fields are changed
Delete a network. Requires network:delete permission.
Create or update a controller. Requires controller:write permission.
Arguments (1)
Controller data
Create a new controller. Requires controller:write permission.
Arguments (1)
Controller data
Update a controller. Only provided fields are changed. Requires controller:write permission.
Arguments (2)
Controller ID to update
Fields to update — only provided fields are changed
Delete a controller. Requires controller:delete permission.
Arguments (1)
Controller ID to delete
Create a new controller token. Returns the signed token value. Requires controller_token:write permission.
Arguments (1)
Controller token data
Revoke a controller token. Requires controller_token:revoke permission.
Arguments (1)
Controller token ID to revoke
Create or update EdgeApp XML and return the authoring view
Arguments (1)
XML and observed draft source for an update
Publish only the reviewed EdgeApp XML; repeated immutable source is a no-op
Create or update a DRAFT edge app row. With input.id: edits the existing draft (rejects PUBLISHED/DEPRECATED rows — those are frozen). Without input.id: creates a new draft for the handle (rejects if a draft already exists). Drafts aren't pushed to controllers; use publishEdgeAppDraft to ship. Requires edge_app:write permission.
Arguments (1)
EdgeApp definition
Compile, validate, and retain an EdgeApp XML document as a DRAFT. Omit id to create; provide a DRAFT id to replace its source.
Arguments (1)
Authoritative EdgeApp XML source
Create a new DRAFT edge app row for input.handle. Rejects if a draft already exists for the handle (finish or delete it first). Drafts aren't pushed to controllers; use publishEdgeAppDraft to ship. Requires edge_app:write permission.
Arguments (1)
EdgeApp definition
Update an existing DRAFT edge app row. Rejects PUBLISHED/DEPRECATED rows (frozen) and attempts to change handle (immutable on an existing draft). Only provided fields are changed. Requires edge_app:write permission.
Arguments (2)
Draft edge app ID to update
Fields to update — only provided fields are changed
Freeze a DRAFT and flip it to PUBLISHED. Auto-deprecates the previously-PUBLISHED row for the same handle. Pushes config.update to every controller running an installation that pinned the newly-published row. Requires edge_app:write.
Arguments (2)
Draft edge app ID to publish
Optional exact reviewed source precondition; publication fails if the current draft no longer matches it.
Mark a PUBLISHED row as DEPRECATED. Used to retire an app without a replacement. Existing installations stay pinned and keep working until upgraded or uninstalled. Idempotent on already-DEPRECATED rows; rejects DRAFT rows (delete them instead). Requires edge_app:write permission.
Delete a edge app row. Cascades to all installations pinning this row and pushes config.update to each affected controller. Use deprecateEdgeApp instead to retire a PUBLISHED row without losing installation history.
Invoke a edgeApp's onMessage export by name on a specific controller (the edgeApp must be installed on it). Forwards to the bridge and returns the function's JSON return value. Requires edge_app:invoke permission.
Arguments (1)
EdgeApp invocation request
Export an edge app to YAML or JSON. Requires edge_app:read permission.
Arguments (1)
Export parameters
Import an edge app from YAML or JSON, landing it as a DRAFT (replaces an existing DRAFT for the handle, or allocates the next version). Requires edge_app:write permission.
Arguments (1)
Import parameters
Type-check Lua source against the ambient typedef for the chosen role without persisting anything. Safe to call from editors on every keystroke.
Arguments (1)
Lua source + role + options
Statically validate a workflow expression (parse + filter-name check) without evaluating it. Safe to call from editors on every keystroke.
Arguments (1)
Workflow expression source + format
Create or update a edgeApp installation. Validates variables against the edgeApp's configSchema (when set) and pushes config.update to the target controller. Requires edge_app_installation:write permission.
Arguments (1)
Installation definition
Create a edgeApp installation. Validates the edgeApp exists in this tenant and isn't DRAFT, that the controller exists, that an optional bot user exists, and variables against the edgeApp's configSchema (when set); pushes config.update to the target controller. Requires edge_app_installation:write permission.
Arguments (1)
Installation definition
Update a edgeApp installation. Only provided fields are changed; edgeAppId is immutable (delete and recreate to change it). Re-validates the controller and bot user (if changed) and variables against the edgeApp's configSchema. Pushes config.update to the controller. Requires edge_app_installation:write permission.
Arguments (2)
EdgeApp installation ID to update
Fields to update — only provided fields are changed
Repoint an installation at a different version of the same edgeApp. Validates the target row exists, belongs to this tenant, shares the installation's current handle, and isn't a DRAFT (only PUBLISHED or DEPRECATED versions can be pinned). Pushes config.update to the controller. The bridge reconciles by installation.id+version, so the new version triggers a restart with the new content. Requires edge_app_installation:write.
Arguments (2)
Edge app installation ID to upgrade
Upgrade input
Delete a edgeApp installation. Triggers a config.update push to the controller.
Arguments (1)
EdgeApp installation ID to delete
Create or update the policy for a controller. Idempotent on controllerId (one row per controller). Wholesale-replace on both allowlists. Triggers a config.update push to the controller. Requires controller_policy:write permission.
Arguments (1)
Policy contents
Create a new controller policy. The referenced controller must exist in this tenant. Triggers a config.update push to the controller. Requires controller_policy:write permission.
Arguments (1)
Policy contents
Update a controller policy. Only provided fields are changed. The referenced controller must exist in this tenant. Triggers a config.update push to the controller. Requires controller_policy:write permission.
Arguments (2)
Controller policy ID to update
Fields to update — only provided fields are changed
Delete a controller's policy. The controller falls back to default-deny on the next config.update push. Requires controller_policy:delete permission.
Arguments (1)
Controller policy ID to delete
Create or update a device. Requires device:write permission.
Arguments (1)
Device data
Create a new device. Requires device:write permission.
Arguments (1)
Device data
Update a device. Only provided fields are changed. Requires device:write permission.
Arguments (2)
Device ID to update
Fields to update — only provided fields are changed
Delete a device. Requires device:delete permission.
Create a new device token. Returns the signed token value. Requires device_token:write permission.
Arguments (1)
Device token data
Revoke a device token. Requires device_token:revoke permission.
Arguments (1)
Device token ID to revoke
Create a new API token for the calling user. Returns the token string only once. Requires apitoken:write permission.
Arguments (1)
Token data
Create a new API token on behalf of a bot user. Fails if the target user is not a bot. Requires apitoken:write permission.
Arguments (1)
Bot token data, including the target bot user ID
Revoke an API token. Requires apitoken:revoke permission.
Arguments (1)
API token ID to revoke
Revoke an API token belonging to a bot user. Fails if the token's owner is not a bot. Requires apitoken:revoke permission.
Arguments (1)
API token ID to revoke
Create or update an AI adapter. Requires aiadapter:write permission.
Arguments (1)
AI adapter data
Create a new AI adapter. Requires aiadapter:write permission.
Arguments (1)
AI adapter data
Update an AI adapter. Only provided fields are changed. Requires aiadapter:write permission.
Arguments (2)
AI adapter ID to update
Fields to update — only provided fields are changed
Delete an AI adapter. Requires aiadapter:delete permission.
Arguments (1)
ID of the AI adapter to delete
Verify provider credentials and all effective configured models using provider model endpoints. Does not generate content. Requires aiadapter:read permission.
Arguments (1)
ID of the AI adapter to test
Create or update an AI agent. Requires aiAgent:write permission.
Arguments (1)
AI agent data
Create a new AI agent. Requires aiAgent:write permission.
Arguments (1)
AI agent data
Update an AI agent. Only provided fields are changed. Requires aiAgent:write permission.
Arguments (2)
AI agent ID to update
Fields to update — only provided fields are changed
Delete an AI agent. Requires aiAgent:delete permission.
Create or replace ML XML authoring source. Updates require the observed authoring revision and preserve training and publication state.
Arguments (1)
Authoritative ML XML and, for updates, the model identity and observed authoring revision.
Create or update an ML model config. Requires mlmodelconfig:write permission.
Arguments (1)
ML model config data
Create a new ML model config. Requires mlmodelconfig:write permission.
Arguments (1)
ML model config data
Update an ML model config. Only provided fields are changed. Requires mlmodelconfig:write permission.
Arguments (2)
ML model config ID to update
Fields to update — only provided fields are changed
Delete an ML model config. Requires mlmodelconfig:delete permission.
Arguments (1)
ID of the ML model config to delete
Trigger training for an ML model. Requires mlmodelconfig:execute permission.
Arguments (1)
ID of the ML model config to train
Run the data pipeline over a sample WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission.
Arguments (3)
ID of the ML model config whose pipeline to preview
Optional stage list to preview instead of the saved stages (live editing)
Max emitted rows to inspect and return in sampleRows (default 1000). totalRows is the number sampled, not a full source count. Zero returns schema only; negative values are invalid. Training still reads the full source.
Import an ML model config from JSON or YAML. Requires mlmodelconfig:write permission.
Arguments (1)
Import input (content, format, optional name override)
Run a prediction using a trained ML model. Requires mlmodelconfig:execute permission.
Arguments (2)
ID of the ML model config to use for prediction
Feature values as JSON string
Forecast future values using a trained time-series model. Requires mlmodelconfig:execute permission.
Manually trigger retraining of all system-managed ML models for the current tenant. Requires mlmodelconfig:execute permission.
Set a version as the published version used for predictions. Requires mlmodelconfig:write permission.
Arguments (2)
ML model config ID
Version ID to publish
Start a personal ML experiment, blank or from an existing model's XML. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (1)
The new experiment
Rename one of your ML experiments or change its draft XML. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (2)
ID of one of your experiments
The changes; omitted fields are unchanged
Delete one of your ML experiments with its runs and their models. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (1)
ID of one of your experiments
Train an experiment's current XML on its CSV as a new numbered run. One run trains at a time per experiment, and at most two per workspace. Older unpinned runs beyond the workspace's keepUnpinnedRuns setting expire. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (1)
ID of one of your experiments
Try one of your experiment runs: predict with its model. Expired and forecast runs are refused. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (2)
ID of one of your trained experiment runs
Feature values as a JSON object string
Try one of your forecast experiment runs: forecast the series it trained on. Expired runs and runs that are not forecasts are refused. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (3)
ID of one of your trained forecast runs
Number of steps past the end of the series to forecast; zero or less uses the run's own horizon
Confidence level (0–1) of the forecast's interval; omitted uses the run's own level
Pin or unpin one of your experiment runs. A pinned run never expires. Pinning is refused once the experiment has the workspace's maxPinnedRuns pinned runs ("Unpin a run first"), or when that setting is 0 ("Pinning is turned off in Settings"); unpinning never is. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (2)
ID of one of your trained experiment runs
True to pin the run, false to unpin it
Run an experiment's data pipeline over a sample of its CSV WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission and a signed-in user.
Arguments (3)
ID of one of your experiments
Optional stage list to preview instead of the stages in the experiment's XML (live editing)
Max emitted rows to inspect and return in sampleRows (default 1000). Zero returns schema only; negative values are invalid.
Create a new chat session. An OPS session needs only a login; any other context requires chatsession:write permission.
Arguments (1)
Chat session data
Update an existing chat session. Requires chatsession:write permission.
Arguments (2)
Chat session ID to update
Chat session update data
Delete a chat session. Requires chatsession:delete permission.
Arguments (1)
ID of the chat session to delete
Send a message to a chat session and receive an AI response. Requires chatsession:write permission.
Arguments (1)
Message to send
Clear all messages from a chat session. Requires chatsession:write permission.
Arguments (1)
Session to clear messages from
Create a new integration definition. Requires integrationDefinition:write permission.
Arguments (1)
Integration definition creation input
Delete an integration definition. The final unused version may be deleted, clearing the current version with integration:write permission. Refuses while any instance is installed from it, rather than cascading — an instance reads its definition's manifest at execution time, so removing one underneath a live integration breaks it at the next fire rather than here. Requires integrationDefinition:delete permission.
Arguments (1)
TypeID (prefix igd) of the definition to delete.
Deprecate an integration definition. Requires integrationDefinition:write permission.
Arguments (1)
Integration definition deprecation input
Create a new integration draft. Requires integrationDefinition:write permission.
Arguments (1)
Draft creation input
Update a single file in a draft's bundle. Requires integrationDefinition:write permission.
Arguments (2)
Integration draft ID to update
File update input
Update manifest fields on a draft. Requires integrationDefinition:write permission.
Arguments (2)
Integration draft ID to update
Manifest update input
Validate a draft without publishing. Requires integrationDefinition:write permission.
Arguments (1)
Validation input
Validate and publish a draft as an active definition. Requires integrationDefinition:write permission.
Arguments (1)
Publish input
Export an integration definition to YAML or JSON. Requires integrationDefinition:read permission.
Arguments (1)
Export parameters
Import an integration definition from YAML or JSON, creating a new DRAFT. Requires integrationDefinition:write permission.
Arguments (1)
Import parameters
Compile XML with the native platform validator without persisting anything. Returns field paths and source ranges. Requires integrationDefinition:read.
Arguments (1)
Integration XML to compile without creating or changing persisted definitions.
Create a native XML definition in DRAFT status under its integration parent. Creates no installation, bindings or secrets. Requires integrationDefinition:write.
Arguments (1)
Exact Integration XML for a new native draft under its declared integration parent.
Replace a native draft XML document using expectedRevision. Root id/version and published versions are immutable. Requires integrationDefinition:write.
Arguments (1)
Draft identity, observed revision and replacement authoritative XML.
Import exact XML as a new native DRAFT version. Existing versions are never overwritten and installation values are not imported. Requires integrationDefinition:write.
Arguments (1)
Exact Integration XML to import as a new draft without overwriting existing versions.
Export the exact authoritative Integration XML, preserving comments, whitespace and CDATA. Requires integrationDefinition:read.
Arguments (1)
Definition version whose authoritative native Integration XML should be exported.
Explicit operator attestation after confirming exact predecessor termination and reconciling all external effects. Fences the retired session and retains evidence; never replays or marks a hook successful. Requires integrationInstance:write.
Arguments (5)
Deleted integration installation whose retired session to reconcile.
Exact retired session from integrationRuntimeRetirements.
Exact authority/predecessor from that retirement's management state; null only when it is null.
Decimal management revision from that retirement's management state.
Required evidence identifying the terminated predecessor process and reconciliation of its external effects; never infer termination from timeout or lease expiry.
Operator attestation: use ONLY after confirming the exact predecessor process has terminated and reconciling all its external effects. Records evidence, fences and pauses the installation; preserves attempt budgets. Requires integrationInstance:write.
Arguments (5)
Integration installation to manage.
Exact native session from integrationRuntimeManagement.
Exact authority/predecessor from integrationRuntimeManagement; null only when that query returns null.
Decimal management revision returned by the query.
Required evidence identifying the terminated predecessor process and reconciliation of its external effects; never infer termination from timeout or lease expiry.
Reset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision. Requires integrationInstance:write.
Arguments (5)
Integration installation to manage.
Exact native session from integrationRuntimeManagement.
Decimal management revision returned by the query.
Exact stable child key returned by integrationRuntimeManagement.
Required operator reason for resetting this stopped child budget.
Create a new integration instance. Requires integrationInstance:write permission.
Arguments (1)
Integration instance creation input
Set one secret on an integration instance. Secrets are not settable through config — this is the only way in. Requires integrationInstance:write permission.
Arguments (3)
TypeID of the integration instance.
Config key to set. Must be declared a secret by the definition's schema (x-input-type: password); see the instance's secrets.
The secret. Stored encrypted and never returned by any query.
Remove a stored secret from an integration instance. Requires integrationInstance:write permission.
Arguments (2)
TypeID of the integration instance.
Secret key to remove.
Update an integration instance. Requires integrationInstance:write permission.
Arguments (2)
Integration instance ID to update
Integration instance update input
Move an integration instance to a newer version of the same integration. Runs the new definition's upgrade hook between stop and start. Requires integrationInstance:write permission.
Arguments (2)
Integration instance ID to upgrade
Integration instance upgrade input
Start an integration instance. Requires integrationInstance:write permission.
Arguments (1)
Integration instance ID to start
Pause an integration instance. Requires integrationInstance:write permission.
Arguments (1)
Integration instance ID to pause
Run a named Action a running integration instance declares, and return its handler's JSON result. Discover Actions and their input schemas on the definition's manifest. Requires integrationInstance:write permission.
Arguments (1)
Run-Action input
Manually fire a named timer on a running integration instance. Requires integrationInstance:write permission.
Arguments (1)
Run-timer input
Delete an integration instance. Requires integrationInstance:delete permission.
Arguments (2)
Integration instance ID to delete
Skip uninstall and permanently delete instance data after runtime shutdown. Remote resources may require manual cleanup.
Create a session token for an integration instance. Requires integrationInstance:read permission.
Arguments (1)
Integration session creation input
Create or update an integration data container. Requires integrationDataContainer:write permission.
Arguments (1)
Container data
Create a new integration data container. Requires integrationDataContainer:write permission.
Arguments (1)
Container data
Update an integration data container. Only provided fields are changed. Requires integrationDataContainer:write permission.
Arguments (2)
Container ID to update
Fields to update — only provided fields are changed
Delete an integration data container. Requires integrationDataContainer:delete permission.
Arguments (1)
Delete input
Create a custom action, or overwrite an existing one when input.id is supplied. Overwrite semantics: omitted optional fields are written as null, unlike updateCustomWorkflowAction. Requires customWorkflowAction:write permission.
Arguments (1)
The action to write. With an id, the existing action is overwritten in place; without one, a new action is created.
Create a new custom action. Requires customWorkflowAction:write permission.
Arguments (1)
Definition of the custom action to create.
Update a custom action. Only provided fields are changed. Requires customWorkflowAction:write permission.
Arguments (2)
TypeID (prefix cac) of the custom action to update.
The fields to change; omitted fields are left as they are.
Permanently delete a custom action from the caller's tenant. Reports notFound when no such action exists. Requires customWorkflowAction:delete permission.
Arguments (1)
TypeID (prefix cac) of the custom action to delete.
Create a new notification group. Requires notificationGroup:write permission.
Arguments (1)
Notification group data
Update a notification group. Requires notificationGroup:write permission.
Arguments (2)
Notification group ID to update
Updated notification group data
Delete a notification group. Requires notificationGroup:delete permission.
Arguments (1)
Notification group ID to delete
Create a new notification recipient. Requires notificationRecipient:write permission.
Arguments (1)
Notification recipient data
Update a notification recipient. Requires notificationRecipient:write permission.
Arguments (2)
Notification recipient ID to update
Updated recipient data
Delete a notification recipient. Requires notificationRecipient:delete permission.
Arguments (1)
Notification recipient ID to delete
Create or update an incoming webhook. Requires incomingWebhook:write permission.
Arguments (1)
Webhook data
Create a new incoming webhook. Requires incomingWebhook:write permission.
Arguments (1)
Webhook data
Update an incoming webhook. Only provided fields are changed. Requires incomingWebhook:write permission.
Arguments (2)
Webhook ID to update
Fields to update — only provided fields are changed
Delete an incoming webhook. Requires incomingWebhook:delete permission.
Arguments (1)
Webhook ID to delete
Create or update a metric. Requires metric:write permission.
Arguments (1)
Metric data
Create a new metric. Requires metric:write permission.
Arguments (1)
Metric data
Update a metric. Only provided fields are changed. Requires metric:write permission.
Arguments (2)
Metric ID to update
Fields to update — only provided fields are changed
Record one or more data points for a metric. Requires metric:write permission.
Arguments (1)
Points to record
Delete a metric and all its data points. Requires metric:delete permission.
Record one or more progress tracking data points. Up to 10,000 points per request. Requires progressPoint:write permission.
Arguments (1)
Points to record
Void or supersede a status event atomically. Preserves original history and records the authenticated actor. Requires workCenter:write permission.
Arguments (1)
Event, audit reason and optional replacement
Record a work centre's status. A status is held until it changes: when it equals the current status, the current event's lastSeenAt is refreshed and that event is returned; otherwise a new event is appended. A timestamp before the current event's is recorded as history. Requires workCenter:write permission.
Arguments (1)
Status event to record
Create a production report and any consumption rows. Requires productionReport:write.
Arguments (1)
The report to record, plus any consumption rows written in the same transaction. Vertical packages add further fields to this input; unknown fields are captured into the report's extensions blob.
Manually reclaim optional source details or closed production report chains. Tenant-scoped, bounded and preview-first; execution may partially succeed across entries. Receipts, acceptance, inventory, costs and completions are retained.
Arguments (5)
Required exclusive UTC cutoff. Every report in a deleted chain must precede it.
Explicit source-details or report-chain reclamation.
Possible values (2)
SOURCE_DETAILSRemove optional source bytes and verbose vertical provenance; preserve quantities, interpretation and bindings.
REPORTSRemove eligible closed report chains and consumption. Requires productionReport:delete in addition to write.
Defaults to true. Preview performs authorization and eligibility checks without deleting data.
Heads/reports examined, 1...100; default 25. Chains longer than 1000 are blocked.
Opaque continuation cursor returned by the preceding page.
Accept physical production once, with optional warehousing. Authorizes each retry and never infers inventory from observation counts.
Arguments (1)
Report portion and explicit physical quantities to accept atomically.
Atomically relocate produced stock without merging holdings or changing total quantity. Every attempt is authorized, including retry replay.
Arguments (1)
Source holding, destination, shared-unit quantity and retry identity.
Record an immutable correction and, when warehoused, reduce only untouched original holdings. Never reverse consumed inputs or downstream-used products.
Arguments (1)
Original report, unused correction report, reason and positive output reductions.
Create a new membership without adopting an existing one. Requires team:write permission.
Arguments (1)
Team and existing user to bind
Set a team member's role. Team admins administer the stacks the team owns. Requires team:write permission.
Arguments (3)
Team containing the membership
Member whose role changes
New role
Possible values (2)
MEMBERDoes the team's work on the stacks it owns
ADMINAlso administers the stacks the team owns: rules, bypass, review dismissal and secrets
Delete only the membership, leaving the user and team intact. Requires team:write permission.
Arguments (1)
Membership identity to delete
Create or update a team. Requires team:write permission.
Arguments (1)
Team data
Create a new team. Requires team:write permission.
Arguments (1)
Team data
Update a team. Only provided fields are changed. Requires team:write permission.
Arguments (2)
Team ID to update
Fields to update — only provided fields are changed
Delete a team. Requires team:delete permission.
Add a user to a team. Requires team:write permission.
Arguments (1)
Add member input
Remove a user from a team. Requires team:write permission.
Arguments (1)
Remove member input
Create or update a task definition. Requires taskDefinition:write permission.
Arguments (1)
Task definition data
Create a new task definition. Requires taskDefinition:write permission.
Arguments (1)
Task definition data
Update a task definition. Only provided fields are changed. Requires taskDefinition:write permission.
Arguments (2)
Task definition ID to update
Fields to update — only provided fields are changed
Delete a task definition. Requires taskDefinition:delete permission.
Arguments (1)
Task definition ID to delete
Create a new task. Requires task:write permission.
Arguments (1)
Task data
Edit task metadata without changing its lifecycle. Requires task:write permission.
Arguments (2)
Existing task whose editable metadata should change.
Metadata edits with omission preserving current values and null clearing supported optional fields.
Transition a task's status. Requires task:transition permission, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
Arguments (1)
Transition input
Complete a journey task with the result of the journey the caller ran. The result is checked against the journey's declared outputs; the journey's own steps already ran as the caller. Requires task:transition, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder. Repeating it with the same result returns the completed task.
Arguments (3)
The journey task to complete
The published version of the task's journey that the caller ran; its declared outputs check the result
The finished run's outputs: an object keyed by the journey's declared output keys (a resource output is { id, label })
Claim a team-assigned task. Requires task:claim permission.
Cancel a task. Requires task:transition permission, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
Create a personal to-do assigned to the caller (MANUAL, ALLOCATED). Any signed-in user; no permission needed.
Arguments (1)
The to-do
Complete an open personal to-do directly, whatever the status order. Its owner or a task:write holder.
Release a claimed team task back to its team: clears the claim and returns it to CREATED. The claimer or a task:write holder.
Delete a task. Requires task:delete permission. A task with logged time, voided entries included, is refused with code TASK_HAS_LOGGED_TIME: cancel it instead.
Start a timer on an open task. A person runs one timer at a time: a timer running on another task is stopped first, in the same write. Starting it again on the same task returns the running timer. Two starts racing leave one timer; the other gets WRITE_CONFLICT. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
Stop the caller's running timer on a task, recording the span between start and now. Only the timer's owner.
Discard the caller's running timer on a task: it is voided with no duration and stays on record. Only the timer's owner.
Log time spent on a task by hand. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
Arguments (5)
The task the time was spent on: open, or finished (completed, rejected or cancelled) within the last 30 days
How long the work took, in seconds: 60 (1 minute) to 86400 (24 hours)
When the work ended (ISO8601); defaults to now. Up to 60 seconds ahead of the server is taken as now; further ahead is refused.
Optional note on what the time was spent on, up to 2000 characters
How the time is recorded: MANUAL (the default) for a log by hand, COMPLETION for time logged when the task is marked done. TIMER is refused: only the timer records it. COMPLETION is refused with TIMER_RUNNING while the caller's timer runs on the task, since completing stops and costs that timer, and with COMPLETION_ALREADY_LOGGED when the caller already has a live COMPLETION entry on the task, open or finished (void it to log again).
Possible values (3)
TIMERStarted and stopped as a timer; the only kind that can be running
MANUALLogged by hand with a duration
COMPLETIONLogged with a duration when the task was marked done
Void a time entry: it stays on record but counts toward no total. To correct an entry, void it and log the time again. Voiding twice changes nothing. The person who logged it, or a task:write holder.
Arguments (2)
The time entry to void
Why the entry is voided, up to 500 characters
Create a capability, or replace an existing one wholesale when input.id is given. Unlike createCapability/updateCapability this does not reject a duplicate code. The capability is written under the caller's tenant. Requires capability:write permission.
Arguments (1)
The capability to create or replace. With input.id the existing capability is overwritten wholesale; without it a new one is created.
Create a new capability. Requires capability:write permission.
Arguments (1)
The capability to create. Its code must not already exist in the caller's tenant.
Update a capability. Only provided fields are changed. Requires capability:write permission.
Arguments (2)
TypeID (prefix "cpb") of the capability to update. Returns a "capability not found" field error when the tenant cannot see it.
The fields to change. Omitted fields keep their current value; a changed code must not collide with another capability in the tenant.
Delete a capability owned by the caller's tenant. Non-tenant-scoped capabilities cannot be deleted: the payload reports success: false instead. Requires capability:delete permission.
Arguments (1)
TypeID (prefix "cpb") of the tenant-owned capability to delete.
Create or overwrite a shift definition in one call. When input.id names an existing definition its createdAt is preserved; otherwise a new "shd" TypeID is minted. Validation failures come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
Arguments (1)
Full state of the shift definition. Omit input.id to create; supply it to overwrite that definition in place.
Create a new shift definition in the caller's tenant; the server mints its "shd" TypeID and timestamps. Validation failures come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
Arguments (1)
Fields for the new shift definition.
Patch an existing shift definition and stamp updatedAt. An unknown id, and any validation failure, come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
Arguments (2)
TypeID (prefix "shd") of the shift definition to patch.
Fields to change; omitted fields keep their current values.
Delete a shift definition from the caller's tenant. Deleting one that does not exist is reported as success: false with an "id" error, not as a GraphQL error. Requires shiftDefinition:delete permission.
Arguments (1)
TypeID (prefix "shd") of the shift definition to delete.
Replaces a work centre's twin settings. This is the only route to them: the work centre's own create and update do not accept them. Requires workCenterBehaviorProfile:write permission.
Arguments (2)
The work centre whose twin to configure
The whole settings; an omitted field is reset to the server default
Create a work center, or fully overwrite an existing one when input.id matches one in the caller's tenant. Unlike updateWorkCenter this replaces every field, so omitted optional fields are cleared. Requires workCenter:write permission.
Arguments (1)
Full work center state to write. Include id to overwrite an existing work center; omit it to create one.
Create a new work center. Requires workCenter:write permission.
Arguments (1)
Attributes of the work center to create. Its id is generated by the server; externalId, when given, must not already be in use in this tenant.
Update a work center. Only provided fields are changed. Requires workCenter:write permission.
Arguments (2)
TypeID (prefix "wcr") of the work center to update.
Partial patch: only the fields present are written, the rest are left as-is.
Permanently delete a work center from the caller's tenant. Returns success = false when no work center with that id exists. Prefer setting lifecycle = ARCHIVED to retire a work center that has production history. Requires workCenter:delete permission.
Arguments (1)
TypeID (prefix "wcr") of the work center to delete.
Assigns a capability to a work center with a server-generated id. Nothing is persisted if a constraint URI fails validation; the errors are returned instead. Requires workCenter:write permission.
Arguments (1)
The work center, capability, and optional constraints to record.
Patches an existing work center capability assignment and refreshes its updatedAt. Returns an "id" error when no such assignment exists in the caller's tenant, and persists nothing if a constraint URI fails validation. Requires workCenter:write permission.
Arguments (2)
TypeID of the assignment to patch (prefix "wcc").
Fields to change; omitted fields keep their stored values.
Creates or wholly overwrites a work center capability assignment. Unlike update, every field is taken from the input, so omitted constraints clear the stored list; an existing record keeps its original createdAt. Requires workCenter:write permission.
Arguments (1)
The full assignment to write; supply id to overwrite an existing one, omit it to create.
Removes a capability assignment from a work center. Returns success: false with an "id" error when the assignment does not exist in the caller's tenant. Requires workCenter:write permission.
Arguments (1)
TypeID of the assignment to remove (prefix "wcc").
Create a new work center ↔ device binding. Requires workCenter:write.
Arguments (1)
The work center, device, and priority/active flags for the new binding.
Update a work center ↔ device binding. Only provided fields are changed. Requires workCenter:write.
Arguments (2)
TypeID (prefix wcd) of the binding to update. Must exist in this tenant.
Fields to change; omitted fields keep their current values.
Bind a controller device to a work center (or update its priority/active flag). Requires workCenter:write.
Arguments (1)
The binding to create or update in place, matched by id when given and otherwise by (workCenterId, deviceId).
Remove a work center ↔ device binding. Requires workCenter:write.
Arguments (1)
TypeID (prefix wcd) of the binding to remove. Removes only the binding — neither the work center nor the device is deleted.
Creates a work center shift profile, or fully replaces an existing one when input.id is supplied (createdAt is preserved). Requires workCenter:write.
Arguments (1)
The profile to write. Supplying an existing id replaces that profile's fields; omitting id creates a new one.
Creates a new work center shift profile with a server-generated id. Requires workCenter:write.
Arguments (1)
The shift assignment to create for the work center.
Partially updates an existing work center shift profile. Returns an id error when no such profile exists in the caller's tenant. Requires workCenter:write.
Arguments (2)
TypeID of the shift profile to update (prefix "wsp").
The fields to change; omitted fields keep their current values.
Permanently deletes a work center shift profile, so the work center no longer runs that shift definition over the profile's window. Requires workCenter:write.
Arguments (1)
TypeID of the shift profile to delete (prefix "wsp").
Create a schedule scenario, or fully replace an existing one when input.id is given. Rejected when the target scenario is locked. Requires scheduleScenario:write permission.
Arguments (1)
Full scenario payload. Include id to overwrite an existing scenario, omit it to create one.
Create a new schedule scenario. Requires scheduleScenario:write permission.
Arguments (1)
Attributes of the scenario to create. Its id is generated by the server.
Update a schedule scenario. Only provided fields are changed. Requires scheduleScenario:write permission.
Arguments (2)
TypeID of the schedule scenario to update (prefix "sch"). An id outside the caller's tenant is reported as not found.
Fields to change. Omitted fields keep their current values.
Permanently delete a schedule scenario. Requires scheduleScenario:delete permission.
Arguments (1)
TypeID of the schedule scenario to delete (prefix "sch"). An id outside the caller's tenant is reported as not found.
Freeze a schedule scenario by stamping lockedAt. Scenario edits and allocation writes are rejected until unlockScheduleScenario clears the lock. Fails if it is already locked. Requires scheduleScenario:write permission.
Arguments (1)
TypeID of the schedule scenario to lock (prefix "sch").
Clear lockedAt so the scenario can be edited and published again. Fails if it is not locked. Requires scheduleScenario:write permission.
Arguments (1)
TypeID of the schedule scenario to unlock (prefix "sch").
Create a schedule allocation, or overwrite an existing one when input.id is supplied (createdAt is preserved). Requires scheduleScenario:write permission.
Arguments (1)
The allocation to create, or — when input.id is given — to overwrite.
Create a new schedule allocation. Requires scheduleScenario:write permission.
Arguments (1)
The allocation to create. Its id is generated server-side.
Update a schedule allocation. Only provided fields are changed. Requires scheduleScenario:write permission.
Arguments (2)
TypeID of the allocation to update ("sal_01K…").
The fields to change; omitted fields keep their current values.
Delete a schedule allocation from its scenario. Returns success: false with an "id" error when no such allocation exists. Requires scheduleScenario:write permission.
Arguments (1)
TypeID of the allocation to delete ("sal_01K…").
Replace a job's entire operation dependency graph: all existing edges for the job are deleted and the supplied ones inserted, in a single transaction that also applies any operation scheduling preferences. Validation (endpoint scopes, no self-loops, no duplicates, no cycles) is atomic with the write; on failure nothing changes and the errors are returned in the payload. Requires operation:write permission.
Arguments (1)
The job's complete edge set, plus optional operation scheduling-preference patches.
Create a single operation dependency edge. Requires operation:write permission.
Arguments (1)
Operation edge data
Update a single operation dependency edge. Only provided fields are changed. Requires operation:write permission.
Arguments (2)
Operation edge ID to update
Fields to update — only provided fields are changed
Create or update a single operation item. Requires operation:write permission.
Arguments (1)
The item to write. Supplying id updates that item, merging omitted fields from the stored values; omitting id creates a new one.
Create a new operation item. Requires operation:write permission.
Arguments (1)
The item to create. A supplied externalId must be unused within the tenant, otherwise the mutation returns an errors entry rather than creating.
Update an operation item. Only provided fields are changed. Requires operation:write permission.
Arguments (2)
Operation item ID to update
Fields to update — only provided fields are changed
Batch upsert operation items for an operation (replaces all existing items). Requires operation:write permission.
Arguments (1)
The operation, its job, and the full item list to write. Runs in one transaction: existing items (and their edges) are deleted, then the supplied items are inserted as new PENDING items with fresh ids.
Transition operation item to a new status. Requires operation:execute permission.
Arguments (1)
The item to move and its target status. A transition the state machine disallows is returned as an errors entry on status, not thrown.
Delete an operation item. Requires operation:delete permission.
Arguments (1)
The item to delete. Deletion is permanent and is not blocked by the item's status; an id outside the tenant reports not-found.
Batch upsert item-level dependency edges. Requires operation:write permission.
Arguments (1)
The job (and optional operation pair) to replace edges within, plus the edges that should exist there afterwards.
Create a single item-level dependency edge. Requires operation:write permission.
Arguments (1)
The job, the two item endpoints, and their owning operations for the new edge.
Patch a single item-level dependency edge. Requires operation:write permission.
Arguments (2)
TypeID of the edge to patch ("oie_01K…"). Resolved within the caller's tenant; an unknown id yields an "id" field error rather than an exception.
The fields to change; omitted fields keep their current values.
Update only quantities on one planned step without replacing its identity, schedule allocations, durations or legacy productionQuantity.
Arguments (2)
Stored planned step to update in place; allocation references are preserved.
Explicit workload and expected good-output quantities with units.
Create or overwrite a production plan together with its full set of planned operations and edges, in one transaction. Children are replaced wholesale (delete-then-insert). Validation failures are returned in the payload's errors rather than thrown. Requires productionPlan:write permission.
Arguments (1)
The plan and its complete set of planned operations and edges. Pass id to overwrite an existing plan; omit it to create a new version.
Create a new production plan. Requires productionPlan:write permission.
Arguments (1)
The plan to create, with its planned operations and edges.
Update a production plan. Only provided fields are changed. Requires productionPlan:write permission.
Arguments (2)
Production plan ID to update
Fields to update — only provided fields are changed
Rebuild a work centre's behaviour profile from its history now, writing a new version. Requires workCenterBehaviorProfile:write permission.
Arguments (1)
The work centre to rebuild
Queue a Monte-Carlo replay of a scenario's allocations against the work centres' learned behaviour profiles. Returns immediately with a QUEUED run; stream progress with scenarioSimulationProgress or poll scenarioSimulationRun. Requires scenarioSimulationRun:execute.
Arguments (1)
The scenario to replay and sampling options
Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.
Arguments (1)
The QUEUED or RUNNING run to cancel
Start a background schedule optimization. Returns immediately with the run ID. Use scheduleOptimizationProgress subscription to stream progress.
Arguments (1)
Optimization configuration
Cancel a running schedule optimization. The run transitions to CANCELLED status.
Arguments (1)
ID of the optimization run to cancel
Create or update a template. Requires template:write permission.
Arguments (1)
Template data
Create a new template. Requires template:write permission.
Arguments (1)
Template data
Update a template. Only provided fields are changed. Requires template:write permission.
Arguments (2)
Template ID to update
Fields to update — only provided fields are changed; kind cannot be changed
Delete a template and all its versions. Requires template:delete permission.
Arguments (1)
Template ID to delete
Validate template syntax without saving. Requires template:read permission.
Arguments (1)
Template content to validate
Publish current template content as a new version. Requires template:write permission.
Arguments (1)
Version publish data
Delete one version from a template's history. Fails when the version is the one the template is currently published at. Requires template:write permission.
Arguments (1)
Template version ID to delete
Restore template content from a previous version. Requires template:write permission.
Arguments (1)
Version restore data
Render a template with context data. Requires template:execute permission.
Arguments (1)
Render input data
Create or update an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
Arguments (1)
File data
Create an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
Arguments (1)
File data
Update a file. Only provided fields are changed. Requires file:write permission.
Arguments (2)
File ID to update
Fields to update — only provided fields are changed
Delete a file. Requires file:delete permission.
Allocate one or more cloud upload URLs. Requires file:write permission.
Arguments (1)
File metadata for the files to be uploaded
Mark one or more uploads as ready. Requires file:write permission.
Arguments (1)
Confirmations for previously-allocated uploads
Resolve a download URL. Managed cloud URLs are provider-signed; EXTERNAL URLs pass through unchanged with no Pulse signature or TTL, and report URLs require authentication at retrieval. Requires file:download permission.
Create a warehouse location in the caller's tenant and emit a created event. Returns validation errors instead of a location when the input is invalid. Requires warehouseLocation:write permission.
Arguments (1)
Fields for the new location; unset optional fields take their defaults.
Apply a partial update to an existing warehouse location and emit an updated event. Returns an error payload when the id is unknown in the caller's tenant or the result fails validation. Requires warehouseLocation:write permission.
Arguments (2)
TypeID ("wlc") of the warehouse location to update.
The fields to change; omitted fields keep their current values.
Create or fully replace a warehouse location by id, preserving the original createdAt when it already exists, and emit an updated event. Because the whole state is written, omitted optional fields are reset to their defaults. Requires warehouseLocation:write permission.
Arguments (1)
Full desired state of the location, optionally carrying the id of the location to replace.
Delete a warehouse location from the caller's tenant and emit a deleted event. Reports a not-found result when no such location exists. Requires warehouseLocation:delete permission.
Arguments (1)
TypeID ("wlc") of the warehouse location to delete.
Create or wholesale-replace a warehouse stock record in the caller's tenant: creates one when input.id is omitted or unknown, otherwise overwrites the existing record. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
Arguments (1)
Full state of the stock record to write.
Create a warehouse stock record in the caller's tenant with a server-assigned WarehouseStock TypeID. Returns validation errors rather than a record when the quantities are invalid. Emits a warehouse-stock created event. Requires write access to warehouse stock.
Arguments (1)
State of the stock record to create.
Patch an existing warehouse stock record in the caller's tenant. Returns an id error when the record does not exist, or validation errors when the patched quantities are invalid. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
Arguments (2)
WarehouseStock TypeID (wst_…) of the record to patch.
Fields to change; omitted fields keep their current value.
Permanently delete a warehouse stock record from the caller's tenant. Reports not-found when no such record exists. Emits a warehouse-stock deleted event. Requires delete access to warehouse stock.
Arguments (1)
WarehouseStock TypeID (wst_…) of the record to delete.
Final consumption: atomically debit source on-hand and reserved quantities and update reservation summary. Requires a resolved, active non-quarantined holding. Shares authority with allocated issueStockToProduction.
Arguments (1)
Partial consumption and expected cumulative counters
Release commitment without consuming stock. Resolved lots release matching holding and reservation counters; unresolved lots change no stock. Release reopens demand, so a future reserveJobMaterials may allocate it again.
Arguments (1)
Partial release and expected cumulative counters
Create a warehouse transfer, or wholly replace an existing one when input.id is supplied. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.
Arguments (1)
Full transfer to write, optionally carrying the id of the transfer to replace.
Create a warehouse transfer in the caller's tenant. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.
Arguments (1)
The transfer to create.
Apply a partial update to an existing warehouse transfer. Returns an error payload when the transfer does not exist, and validation errors when the result would have a matching source and destination or a non-positive quantity. Requires warehouseTransfer:write permission.
Arguments (2)
TypeID of the transfer to update (prefix "wtr").
The fields to change; omitted fields are left as they are.
Permanently delete a warehouse transfer from the caller's tenant. Reports not-found rather than failing when no such transfer exists. Requires warehouseTransfer:delete permission.
Arguments (1)
TypeID of the transfer to delete (prefix "wtr").
Create or update a carrier. Requires carrier:write permission.
Arguments (1)
Carrier data
Create a new carrier. Requires carrier:write permission.
Arguments (1)
Carrier data
Update a carrier. Only provided fields are changed. Requires carrier:write permission.
Arguments (2)
Carrier ID to update
Fields to update — only provided fields are changed
Delete a carrier. Requires carrier:delete permission.
Create or update a shipment. Requires shipment:write permission.
Arguments (1)
Shipment data
Create a new shipment. Requires shipment:write permission.
Arguments (1)
Shipment data
Update a shipment. Only provided fields are changed. Requires shipment:write permission.
Arguments (2)
Shipment ID to update
Fields to update — only provided fields are changed
Delete a shipment. Requires shipment:delete permission.
Arguments (1)
Shipment ID to delete
Create a new shipment package. Requires shipment:write permission.
Arguments (1)
Shipment package data
Update a shipment package. Only provided fields are changed. Requires shipment:write permission.
Arguments (2)
Shipment package ID to update
Fields to update — only provided fields are changed
Create or update a shipment package. Requires shipment:write permission.
Arguments (1)
Shipment package data
Delete a shipment package. Requires shipment:delete permission.
Arguments (1)
Shipment package ID to delete
Create or update a shipment item. Requires shipment:write permission.
Arguments (1)
Shipment item data
Create a new shipment item. Requires shipment:write permission.
Arguments (1)
Shipment item data
Update a shipment item. Only provided fields are changed. Requires shipment:write permission.
Arguments (2)
Shipment item ID to update
Fields to update — only provided fields are changed
Delete a shipment item. Requires shipment:delete permission.
Arguments (1)
Shipment item ID to delete
createPlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
Arguments (1)
input
updatePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
Arguments (3)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
Complete replacement; optional fields omitted here are cleared
deletePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
Arguments (2)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
createPlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
Arguments (1)
input
updatePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
Arguments (3)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
Complete replacement; optional fields omitted here are cleared
deletePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
Arguments (2)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
createShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
Arguments (1)
input
updateShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
Arguments (3)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
Complete replacement; optional fields omitted here are cleared
deleteShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:delete and shipment:write
Arguments (2)
Typed resource identifier
Current version required for optimistic concurrency; stale writes fail
createFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
Arguments (1)
Input for this fulfillment specification
createCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
Arguments (1)
Input for this fulfillment specification
updateCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
Arguments (3)
Id for this fulfillment specification
Current version required for the operation
Input for this fulfillment specification
retireFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
Arguments (2)
Id for this fulfillment specification
Current version required for the operation
retireCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
Arguments (2)
Id for this fulfillment specification
Current version required for the operation
resolveCustomerFulfillmentDefaults; explicit structural operation, no lifecycle gating or execution side effects
Arguments (3)
Owning planned delivery
Explicit customer supplying defaults; never inferred from recipient or billing
Current version required for the operation
recordShipmentItemEvidence; validates structure and permissions without lifecycle gating
Arguments (1)
input; explicit evidence operation
attributeShipmentItemEvidence; validates structure and permissions without lifecycle gating
Arguments (4)
evidenceId; explicit evidence operation
expectedVersion; explicit evidence operation
requestKey; explicit evidence operation
input; explicit evidence operation
Records evidence without running approvals, sending messages or enforcing lifecycle rules
Arguments (1)
Version, scope, typed fact and retry identity
Save only the fulfillment section, preserving every other settings section
Arguments (1)
Completion policy; saving does not change any order or shipment
Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
Arguments (2)
Active order to complete after atomic quantity assessment
Policy reviewed by caller; a changed setting requires review
Possible values (2)
DISPATCHExplicitly attributed dispatched quantities establish quantity completion
DELIVERYExplicitly attributed gross receipts establish quantity completion; default
Save note changes independently of embedding success
Arguments (1)
input for the explicit note mutation
Save note changes independently of embedding success
Arguments (3)
id for the explicit note mutation
expectedVersion for the explicit note mutation
input for the explicit note mutation
Save note changes independently of embedding success
Arguments (2)
id for the explicit note mutation
expectedVersion for the explicit note mutation
Queue bounded recoverable indexing work using the current model
Create or update an order. Requires order:write permission.
Arguments (1)
Order data
Create a new order. Requires order:write permission.
Arguments (1)
Order data
Update an order. Only provided fields are changed. Requires order:write permission.
Arguments (2)
Order ID to update
Fields to update — only provided fields are changed
Create a complete order — header, customer, billing/shipping addresses, and lines — in a single transaction. Each nested input reuses the same type as the corresponding individual upsert mutation; nested ids are rejected because this mutation is create-only. The resolver also enforces customer:write / address:write / orderline:write when those nested inputs are provided.
Arguments (1)
Converged order input including nested customer, addresses, and lines
Delete an order. Requires order:delete permission.
Create or update an order line. Requires order:write permission.
Arguments (1)
Order line data
Create a new order line. Requires order:write permission.
Arguments (1)
Order line data
Update an order line. Only provided fields are changed. Requires order:write permission.
Arguments (2)
Order line ID to update
Fields to update — only provided fields are changed
Delete an order line. Requires order:delete permission.
Arguments (1)
Order line ID to delete
Create or update an estimate. Requires estimate:write permission.
Arguments (1)
Estimate data
Create a new estimate. Requires estimate:write permission.
Arguments (1)
Estimate data
Update an estimate. Only provided fields are changed. Requires estimate:write permission.
Arguments (2)
Estimate ID to update
Fields to update — only provided fields are changed
Delete an estimate. Requires estimate:delete permission.
Arguments (1)
Estimate ID to delete
Create or update an estimate line. Requires estimate:write permission.
Arguments (1)
Estimate line data
Create a new estimate line. Requires estimate:write permission.
Arguments (1)
Estimate line data
Update an estimate line. Only provided fields are changed. Requires estimate:write permission.
Arguments (2)
Estimate line ID to update
Fields to update — only provided fields are changed
Delete an estimate line. Requires estimate:delete permission.
Arguments (1)
Estimate line ID to delete
Create or update an invoice. Requires invoice:write permission.
Arguments (1)
Invoice data
Create a new invoice. Requires invoice:write permission.
Arguments (1)
Invoice data for new invoice
Update an existing invoice. Requires invoice:write permission.
Arguments (2)
Invoice ID to update
Invoice fields to update (patch semantics)
Delete an invoice. Requires invoice:delete permission.
Create or update an invoice line. Requires invoice:write permission.
Arguments (1)
Invoice line data
Create a new invoice line. Requires invoice:write permission.
Arguments (1)
Invoice line data
Update an invoice line. Only provided fields are changed. Requires invoice:write permission.
Arguments (2)
Invoice line ID to update
Fields to update — only provided fields are changed
Delete an invoice line. Requires invoice:delete permission.
Arguments (1)
Invoice line ID to delete
Record a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (paidAmount, paid/partiallyPaid, paidAt) and its order (paymentStatus), atomically. Requires payment:write permission.
Arguments (1)
The invoice being paid and the amount, plus the optional ledger detail (currency, method, reference, notes, receipt date) and the invoice-level payment method/reference.
Delete a payment record. Requires payment:delete permission.
Create or update a supplier. Requires supplier:write permission.
Arguments (1)
Supplier data
Create a new supplier. Requires supplier:write permission.
Arguments (1)
Supplier data
Update a supplier. Only provided fields are changed. Requires supplier:write permission.
Arguments (2)
Supplier ID to update
Fields to update — only provided fields are changed
Delete a supplier. Requires supplier:delete permission.
Arguments (1)
Supplier ID to delete
Create or update a purchase order. Requires purchaseOrder:write permission.
Arguments (1)
Purchase order data
Update a purchase order. Only provided fields are changed. Requires purchaseOrder:write permission.
Arguments (2)
Purchase order ID to update
Fields to update — only provided fields are changed
Delete a purchase order. Requires purchaseOrder:delete permission.
Arguments (1)
Purchase order ID to delete
Create or update a purchase order line. Requires purchaseOrder:write permission.
Arguments (1)
Purchase order line data
Create a new purchase order line. Requires purchaseOrder:write permission.
Arguments (1)
Purchase order line data
Update a purchase order line. Only provided fields are changed. Requires purchaseOrder:write permission.
Arguments (2)
Purchase order line ID to update
Fields to update — only provided fields are changed
Delete a purchase order line. Requires purchaseOrder:delete permission.
Arguments (1)
Purchase order line ID to delete
Create or update a product. Requires product:write permission.
Arguments (1)
Product data
Create a new product. Requires product:write permission.
Arguments (1)
Product data
Update a product. Only provided fields are changed. Requires product:write permission.
Arguments (2)
Product ID to update
Fields to update — only provided fields are changed
Delete a product. Requires product:delete permission.
Create or update a job material reservation. Requires jobMaterialReservation:write permission.
Arguments (1)
Reservation data
Create a new job material reservation. Requires jobMaterialReservation:write permission.
Arguments (1)
Reservation data
Update a job material reservation. Only provided fields are changed. Requires jobMaterialReservation:write permission.
Arguments (2)
Reservation ID to update
Fields to update — only provided fields are changed
Delete a job material reservation. Requires jobMaterialReservation:delete permission.
Arguments (1)
Reservation ID to delete
Attempt to reserve warehouse stock for all pending material reservations on a job. Requires jobMaterialReservation:write permission.
Arguments (1)
Job ID to process reservations for
Convert an accepted estimate into an order with order lines. Requires order:write.
Arguments (1)
Estimate to convert, plus optional overrides for the order's number, date and notes.
Create a new revision of an estimate, copying all lines. Requires estimate:write.
Arguments (1)
Estimate to supersede, plus optional notes for the new revision.
Create jobs from order lines. Requires job:write.
Arguments (1)
Order to produce, and the per-order-line jobs to create from it.
Accept an estimate and create order + jobs with components/operations from production blueprints. Requires order:write.
Arguments (1)
Estimate to accept, plus optional order number, date, notes and job priority.
Generate an invoice from an order and its lines. Rejects orders that already have an invoice, including concurrent retries. Requires invoice:write.
Arguments (1)
Order to invoice, its invoice number, and optional dates, terms and notes.
Issue a credit note against an invoice. Requires invoice:write.
Arguments (1)
Invoice to credit, the credit-note number, a reason, and optional partial-credit lines.
Create a shipment with packages and items, marking it as picked up. Requires shipment:write.
Arguments (1)
The shipment header plus every package and item to create with it.
Update shipment status and tracking details. Requires shipment:write.
Arguments (1)
The shipment to update, its new status, and any tracking details to set.
Create a purchase order with lines, computing totals automatically. Requires purchaseOrder:write.
Arguments (1)
The supplier, PO number, currency and lines of the order to create.
Record receipt of purchase order lines, optionally adding to warehouse stock. Requires purchaseOrder:write.
Arguments (1)
The purchase order being delivered against, the quantities received per line, and optionally the warehouse location to put the goods away into.
Issue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.
Arguments (1)
The stock records to draw down, how much of each to issue, and the job the stock is consumed by.
Perform a stock count, adjusting quantities and recording differences. Requires warehouseStock:write.
Arguments (1)
The warehouse location being counted and the quantity physically found for each of its stock records.
Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines. Requires estimate:write permission.
Arguments (1)
Customer, commercial terms (currency, margin, tax, validity), and the items to quote — each item's spec drives operation inference and cost calculation.
Export the tenant's cost configuration (categories, rates, operation mappings) as a flat CSV string for spreadsheet editing.
Import cost configuration from a CSV string. Upserts cost categories, operation-to-category mappings, and cost rates in a single transaction.
Arguments (1)
The CSV to import and the merge mode to apply. Rate values are interpreted as an amount in the row's ISO 4217 currency (defaulting to EUR when blank) per one of the cost category's units (e.g. 75.0 / EUR / HOURS = EUR 75 per hour).
Update the status of multiple orders at once. Requires order:write.
Arguments (1)
The orders to move, the status to apply, and an optional internal note. Unknown order ids do not abort the batch — they come back in failedOrderIds.
Duplicate an estimate for a different customer, optionally adjusting prices. Requires estimate:write.
Arguments (1)
The source estimate, the customer to re-issue it to, and optional overrides (estimate number, contact, billing address, price adjustment, notes).
Validate a Lua script for syntax errors. Requires script:execute permission.
Execute a Lua script in the playground sandbox. Requires script:execute permission.
Arguments (1)
Script execution input
Create or update a data clip
Arguments (1)
Clip fields to write. Include id to overwrite an existing clip, omit it to create a new one.
Create a new data clip
Arguments (1)
Name, optional description and MicroSQL query for the new clip.
Update a data clip
Arguments (2)
TypeID of the clip to update (e.g. "dcl_01K…"). Must exist in the caller's tenant.
Fields to change. Omitted fields are left untouched.
Delete a data clip
Arguments (1)
TypeID of the clip to delete (e.g. "dcl_01K…"). Deletion also kills the clip's public export links.
Queue one run per parameter object under an idempotent batch key.
Arguments (1)
Configuration and parameter values for this operation.
Queue a preview execution of an inline report definition.
Arguments (1)
Configuration and parameter values for this operation.
Execute an inline report definition without publishing a reusable report.
Arguments (1)
Configuration and parameter values for this operation.
Queue another attempt of a failed report run.
Arguments (1)
Report run identifier.
Archive a report from active authoring.
Create or update a report schedule.
Arguments (1)
Configuration and parameter values for this operation.
Pause future firings of a report schedule.
Arguments (1)
Report schedule identifier.
Create or replace a report draft using XML source.
Arguments (1)
XML authoring values and observed revision.
Publish the specified report source with an exact-source precondition.
Create a report or replace its editable draft.
Arguments (1)
Configuration and parameter values for this operation.
Validate and publish the current draft as an immutable version.
Queue a run and return its durable ID immediately. Poll reportRun, then download reportArtifacts.
Arguments (1)
Configuration and parameter values for this operation.
Request cancellation of a report execution.
Arguments (1)
Report run identifier.
Create or update an external schema. Triggers background processing. Requires externalSchema:write permission.
Arguments (1)
External schema data
Create a new external schema. Triggers background processing. Requires externalSchema:write permission.
Arguments (1)
External schema data
Update an external schema. Only provided fields are changed. Triggers background processing if sourceText is changed. Requires externalSchema:write permission.
Arguments (2)
External schema ID to update
Fields to update — only provided fields are changed
Delete an external schema and all its entries. Requires externalSchema:delete permission.
Arguments (1)
ID of the external schema to delete
Create or replace an API definition and compile its types without I/O. Updates require the current revision. Compilation failures are saved with diagnostics.
Arguments (3)
API client definition identity.
Current definition revision; required for updates and deletion.
API definition to create or replace.
Delete an API definition only when its current revision matches.
Arguments (2)
API client definition identity.
Current definition revision; required for updates and deletion.
Update tenant configuration. Creates a new version. For SECRET entries with null value, the existing secret is preserved. Requires tenantConfig:write permission.
Arguments (1)
Config entries to set
Delete a config key. Creates a new version. Requires tenantConfig:write permission.
Rollback to a previous config version. Creates a new version with the old data. Requires tenantConfig:write permission.
Infer the required production operations for a component. Provide either componentId or spec. When imposing config is provided, returns full production-grade DAG.
Arguments (1)
What to infer operations for: either componentId (fetches the component, job and section) or an inline spec. Verticals may contribute extra fields (e.g. print's imposing config).
Start the OAuth consent flow for a Google Drive or Dropbox backend. Persists a draft backend (status NEEDS_REAUTHORIZATION) and returns the provider consent URL to send the user to; the callback completes the draft. Requires storageBackend:write permission.
Arguments (1)
Which OAuth provider to connect, and the name/description for the backend the flow will produce.
Create or update a storage backend in one call. Prefer createStorageBackend / updateStorageBackend, which have the same validation but distinct create/update semantics. Requires storageBackend:write permission.
Arguments (1)
The backend to create (id omitted) or update (id present), including its kind-specific config.
Create a new storage backend. Requires storageBackend:write permission.
Arguments (1)
The backend to create, including the credentials for its kind.
Update a storage backend. Only provided fields are changed. Requires storageBackend:write permission.
Arguments (2)
Storage backend ID to update
Fields to update — only provided fields are changed
Delete a storage backend. Returns a notFound payload when no such backend exists in the caller's tenant. Also the way to clean up a draft left behind by an abandoned OAuth flow. Requires storageBackend:delete permission.
Arguments (1)
TypeID (sbk_ prefix) of the backend to delete.
Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.
Arguments (1)
TypeID (sbk_ prefix) of the backend to probe.
Create an archive job, or fully overwrite an existing one when input.id is given. Unlike updateArchiveJob, omitted optional fields fall back to the existing value and then to the default. Requires archiveJob:write permission.
Arguments (1)
Full archive job definition; its id decides whether an existing job is overwritten or a new one created.
Create a new archive job. Requires archiveJob:write permission.
Arguments (1)
Definition of the archive job to create.
Update an archive job. Only provided fields are changed. Requires archiveJob:write permission.
Arguments (2)
TypeID (prefix arj) of the archive job to update.
Patch to apply; only the fields present are changed.
Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.
Arguments (1)
TypeID (prefix arj) of the archive job to delete.
Run an archive job immediately, regardless of its schedule or isEnabled flag. Enqueues the work and returns a PENDING ArchiveExecution to poll; the run itself happens asynchronously. Requires an authenticated user and archiveJob:execute permission.
Arguments (1)
TypeID (prefix arj) of the archive job to run now.
Creates a folder in the caller's tenant. The binding reference must resolve to a storage backend or controller owned by the tenant, the name must be unique within it, and at most one folder may be the tenant default. Requires folder:write permission.
Arguments (1)
Name, transport binding and root path for the new folder.
Patches a folder. Omitted fields are left unchanged. A folder that files already reference may not have its binding or root path changed (stored file handles would resolve against the wrong transport/prefix), and the tenant default may be moved to another folder but never simply unset. Requires folder:write permission.
Arguments (2)
Folder ID to update
The fields to change; omitted fields keep their stored values.
Deletes a folder. Refused for the tenant default folder and for any folder still referenced by files — the stored bytes would be orphaned. Requires folder:delete permission.
Checks a folder transport with a read-only stat probe. CONTROL_CLOUD reports UNKNOWN because its sentinel probe cannot verify tenant storage provisioning or remote reachability. Other bindings accept an absent sentinel as reachable; this does not test write permissions. Nothing is written, and no folder state changes. Requires folder:read permission.
Test credentials and required TLS without importing or sending mail.
Arguments (2)
InboxFolder ID.
Retrieval or SMTP connection to probe.
Possible values (2)
RETRIEVALretrieval
SUBMISSIONsubmission
Create a disabled mailbox configuration.
Arguments (1)
Complete configuration. Created disabled.
Replace a paused configuration using optimistic concurrency.
Arguments (3)
InboxFolder ID.
Revision read by the caller.
Replacement configuration; credentials are unchanged.
Probe retrieval credentials and storage capabilities, then enable retrieval from a no-backlog baseline.
Arguments (2)
InboxFolder ID.
Current configuration revision.
Recheck retrieval and storage before resuming the saved cursor.
Arguments (2)
InboxFolder ID.
Current configuration revision.
Pause polling and fence in-flight mailbox work.
Arguments (2)
InboxFolder ID.
Current configuration revision.
Terminally archive a mailbox, revoke its credentials, and preserve message/send evidence.
Arguments (2)
InboxFolder ID.
Current configuration revision.
Remove an empty archived configuration without deleting its storage Folder.
Arguments (1)
Archived InboxFolder ID. Deletion succeeds only when no operational evidence remains.
Replace a paused mailbox and reset its namespace without importing existing messages.
Arguments (3)
InboxFolder ID.
Current configuration revision.
Replacement configuration after pausing; new retrieval identity starts at a baseline.
Store a mailbox credential without returning it.
Arguments (2)
InboxFolder ID.
Write-only credential replacement.
Request fresh bounded parsing/scanning with an audited reason. Admission is never directly bypassed.
Arguments (3)
Held or quarantined message to recheck.
Record operator approval for admission if the fresh checks pass; checks are never skipped.
Audited reason for the release.
Acquire a bounded operator retention hold.
Release this operator's retention hold with an audited reason.
Arguments (2)
Message whose hold to release.
Audited reason for the release.
Create one bounded new delivery generation for a currently enabled matching trigger.
Arguments (3)
Accepted message to deliver again.
Enabled workflow trigger that matches the message.
Audited reason for the replay.
Dismiss a pending or paused delivery and release its pending content hold atomically.
Arguments (2)
Delivery identifier from inboxDeliveries.
Audited reason for the dismissal.
Approve the exact configured From address, SMTP settings and current submission credential.
Arguments (1)
Mailbox whose current sender settings to approve.
Persist an idempotent reply request after fresh actor, sender, recipient, File and scan checks.
Arguments (11)
Approved mailbox to send from.
Primary recipient addresses.
Copy recipient addresses.
Subject line.
Plain-text body.
Optional HTML body sent alongside the text.
Managed Files to attach; each must be readable by the caller and pass scanning.
Accepted inbox message being answered, if any.
Message-ID for the In-Reply-To header.
Message-IDs for the References header.
Caller key; repeating a request with the same key returns the original outbound message.
Audit an operator's confirmation or explicit resend decision for unknown delivery.
Arguments (4)
Mailbox the outbound message belongs to.
Outbound message whose delivery is unknown.
CONFIRMED_SENT to record delivery, or AUTHORIZED_RESEND to allow another attempt.
Audited operator note explaining the decision.
Manually author a concept in the ontology. Requires concept:write permission.
Arguments (1)
The concept to create.
Rename or reclassify an existing concept. Requires concept:write permission.
Arguments (2)
Concept ID to update
The concept edit (label and/or kind).
Delete a concept. Requires concept:delete permission.
Contribute a knowledge note about a concept or an entity. Requires knowledgeNote:write permission.
Arguments (1)
The note to contribute.
Edit a note's body or scope, or supersede it with a replacement. The attachment is immutable. Requires knowledgeNote:write permission.
Arguments (2)
Knowledge note ID to update
The note edit (body, scope, or supersession).
Endorse a note: increments its confirmation count (raising its retrieval trust weight) and promotes a PENDING note to LIVE. Requires knowledgeNote:write permission.
Arguments (1)
Note to confirm.
Delete a note and any graph edges it sourced. Requires knowledgeNote:delete permission.
Arguments (1)
Note to delete.
Record that two notes contradict each other; the conflict is surfaced by retrieveKnowledge via KnowledgeHit.contradicts. Requires knowledgeNote:write permission.
Arguments (2)
First note in the contradicting pair.
Second note in the contradicting pair.
Remove a previously recorded contradiction between two notes. Requires knowledgeNote:write permission.
Arguments (2)
First note in the pair.
Second note in the pair.
Capture a knowledge subgraph — concepts, a note, and instance/semantic edges — in one atomic transaction. The manual, deterministic core of knowledge capture; the Phase-2 LLM path produces this same input. scope is caller-controlled. Requires knowledgeNote:write permission.
Arguments (1)
The subgraph to capture.
Add or update an artwork file reference on a component. Requires componentArtworkFile:write permission.
Arguments (1)
Artwork file reference data
Remove an artwork file reference from a component. Requires componentArtworkFile:delete permission.
Arguments (1)
Artwork file reference to delete
Create a new component or BatchComponent imposition specification. Requires impositionSpec:write permission.
Arguments (1)
Imposition spec data
Update an existing component or BatchComponent imposition specification. Requires impositionSpec:write permission.
Arguments (1)
Imposition spec data
Add or update an imposition spec on a component or batch form. Requires impositionSpec:write permission.
Arguments (1)
Imposition spec data
Remove an imposition spec from a component. Requires impositionSpec:delete permission.
Arguments (1)
Imposition spec to delete
Calculate imposition layout for a component and create ImpositionSpec records. Finished size, bleed, page count, and quantity are read from the component. Requires impositionSpec:write permission.
Arguments (1)
Imposition calculation parameters
Re-prepare and atomically retain immutable print product definitions and expected work. Requires operation write permission, impositionSpec read for book/sheet preparation or execute for inline rendering, and managed file download permission when applicable. Stable product IDs support safe retries; no stock is changed.
Arguments (1)
One preparation family and reviewed producer assignments, with optional existing consumer links.
Revalidate existing input/work and atomically retain folded product definitions and expected outputs. Stable IDs support retries; stock and production reports are unchanged.
Arguments (1)
Distinct reviewed folded outputs to retain atomically against existing input requirements.
Atomically retain separated product definitions, cutting setup, expected outputs and exact selected consumer bindings. Preserves other inputs and routes. Does not accept production or create stock; ordinary acceptance enforces cumulative separation yield.
Arguments (3)
Same separation selection, grouping and routes reviewed during preparation.
Unchanged preparation fingerprint; stale material, work or graph facts reject the transaction.
One stable product ID for every reviewed output key.
Create or update a prepress operation on a component. Requires prepressOperation:write permission.
Arguments (1)
Prepress operation data
Delete a prepress operation. Requires prepressOperation:delete permission.
Arguments (1)
Prepress operation to delete
Create or update a preflight report on a component. Requires preflightReport:write permission.
Arguments (1)
Preflight report data
Delete a preflight report. Requires preflightReport:delete permission.
Arguments (1)
Preflight report to delete
Run the PrepressKit preflight engine on an artwork file and persist the report. Requires preflightReport:write permission.
Arguments (1)
Artwork to preflight
Extract ISO 19593-1 production steps from an artwork file and derive Operations (optionally persisting them). Requires operation:write permission.
Arguments (1)
Artwork to extract production operations from
Instantiate a published product template into a print job. Requires productTemplate:execute permission.
Arguments (1)
Instantiation parameters
Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
Arguments (1)
Slug of the canonical template to install.
Create a new substrate, failing if the code is already taken. Requires substrate:write permission.
Arguments (1)
Substrate data
Update a substrate in place. Only provided fields are changed. Requires substrate:write permission.
Arguments (2)
ID of the substrate to update
Fields to update — only provided fields are changed
Create or update a substrate. Requires substrate:write permission.
Arguments (1)
Substrate data
Delete a substrate. Requires substrate:delete permission.
Arguments (1)
ID of the substrate to delete
Create a new substrate template line. Requires substrateTemplateLine:write permission.
Arguments (1)
Substrate template line data
Update a substrate template line in place. Only provided fields are changed. Requires substrateTemplateLine:write permission.
Arguments (2)
Substrate template line ID to update
Fields to update — only provided fields are changed
Create or update a substrate template line. Requires substrateTemplateLine:write permission.
Arguments (1)
Substrate template line data
Delete a substrate template line. Requires substrateTemplateLine:delete permission.
Arguments (1)
Substrate template line ID to delete
Set or clear the imposition specification an operation runs. Requires operation:write and impositionSpec:read permission.
Arguments (1)
Operation and imposition specification
Set or clear the imposition specification one operation item (form) runs. Requires operation:write and impositionSpec:read permission.
Arguments (1)
Operation item and imposition specification
Discover the devices known to a JMF controller (KnownDevices). Requires device:execute permission.
Interrogate the message services a JMF controller supports (KnownMessages). Requires device:execute permission.
Configure the controller bridge JMF endpoint (generates basic-auth credentials when enabled). Direct /api/v1/jmf is configured separately with updateJmfSettings. Requires controller:write.
Arguments (1)
Desired JMF configuration; unset optional fields keep their current value (or fall back to the defaults on first configuration).
Remove a controller's JMF configuration. Requires controller:write.
Arguments (1)
TypeID (ctl_…) of the controller whose JMF config to remove. The controller itself is untouched.
Set the canonical JMF DeviceID on a work center ↔ device binding for inbound correlation. The legacy WorkCenter.jmfDeviceId remains a fallback alias; it is not copied because a work center can have several controller-specific IDs. Requires workCenter:write.
Arguments (1)
Binding to address and the JMF DeviceID to store on it (null clears it; a blank string is rejected).
Saves the paper weight section. Other sections are untouched.
Arguments (1)
The new paper weight settings.
Saves the imposing section. Other sections are untouched.
Arguments (1)
The new imposing settings.
Turns the direct JMF endpoint on or off. The token is untouched.
Arguments (1)
The new JMF endpoint settings.
Sets or replaces the JMF access token with one you supply, e.g. the one your devices already send.
Arguments (1)
The token to use.
Sets or replaces the JMF access token with a new random one, returned once in the result.
Removes the JMF access token. While the endpoint is on, anything that can reach it can then post signals.
Shows the JMF access token so an operator can set up a device. Every reveal is recorded with who and when.
Retry unresolved or observed execution decisions under the current policy without duplicating progress.
Arguments (1)
Observation fingerprint from ingestion diagnostics.
Registers a submission's execution targets and queue response for automatic JMF tracking.
Arguments (1)
Submission attempt and immutable target coverage.
Import one completed, unambiguously scoped JDF process snapshot. XML is transient unless tenant debugging retention is enabled. Does not change execution, inventory or costs.
Arguments (1)
The JDF snapshot and the operation it reports on.
Create or update an address. Requires address:write permission.
Arguments (1)
Address data
Create a new address. Requires address:write permission.
Arguments (1)
Address data
Update an address. Only provided fields are changed. Requires address:write permission.
Arguments (2)
Address ID to update
Fields to update — only provided fields are changed
Delete an address. Requires address:delete permission.
Create or update a business unit. Requires businessunit:write permission.
Arguments (1)
Business unit data
Create a new business unit. Requires businessunit:write permission.
Arguments (1)
Business unit data
Update a business unit. Only provided fields are changed. Requires businessunit:write permission.
Arguments (2)
Business unit ID to update
Fields to update — only provided fields are changed
Delete a business unit. Requires businessunit:delete permission.
Arguments (1)
Business unit ID to delete
Create or update a contact. Requires contact:write permission.
Arguments (1)
Contact data
Create a new contact. Requires contact:write permission.
Arguments (1)
Contact data
Update a contact. Only provided fields are changed. Requires contact:write permission.
Arguments (2)
Contact ID to update
Fields to update — only provided fields are changed
Delete a contact. Requires contact:delete permission.
Create a new cost category, failing if the code is already taken. Requires costcategory:write permission.
Arguments (1)
Cost category data
Update a cost category in place. Only provided fields are changed. Requires costcategory:write permission.
Arguments (2)
Cost category ID to update
Fields to update — only provided fields are changed
Create or update a cost category. Requires costcategory:write permission.
Arguments (1)
Cost category data
Delete a cost category. Requires costcategory:delete permission.
Arguments (1)
Cost category ID to delete
Create or update a cost center. Requires costcenter:write permission.
Arguments (1)
Cost center data
Create a new cost center. Requires costcenter:write permission.
Arguments (1)
Cost center data
Update a cost center. Only provided fields are changed. Requires costcenter:write permission.
Arguments (2)
Cost center ID to update
Fields to update — only provided fields are changed
Delete a cost center. Requires costcenter:delete permission.
Arguments (1)
Cost center ID to delete
Create or update a cost rate. Updates create a new version for audit trail. Requires costrate:write permission.
Arguments (1)
Cost rate data
Create a new cost rate (always version 1). Requires costrate:write permission.
Arguments (1)
Cost rate data
Delete a cost rate nothing depends on. Refused, never cascaded, while recorded costs were priced with it or a later version replaces it; deleting the newest version makes the one it replaced current again. Requires costrate:delete permission.
Arguments (1)
Cost rate ID to delete
Update a cost rate in place (does not create a new version, unlike upsertCostRate). Only provided fields are changed. Requires costrate:write permission.
Arguments (2)
Cost rate ID to update
Fields to update — only provided fields are changed
Create or update a customer. Requires customer:write permission.
Arguments (1)
Customer data
Create a new customer. Requires customer:write permission.
Arguments (1)
Customer data
Update a customer. Only provided fields are changed. Requires customer:write permission.
Arguments (2)
Customer ID to update
Fields to update — only provided fields are changed
Delete a customer. Requires customer:delete permission.
Arguments (1)
Customer ID to delete
Create or update a customer price override. Requires customerPriceOverride:write permission.
Arguments (1)
Full override definition. When input.id is supplied the existing override is replaced field-for-field; when it is omitted a new override is created.
Create a new customer price override. Requires customerPriceOverride:write permission.
Arguments (1)
Definition of the override to create. The id is server-assigned (a cpo_ TypeID) and the override is scoped to the caller's tenant.
Update a customer price override. Only provided fields are changed. Requires customerPriceOverride:write permission.
Arguments (2)
TypeID (cpo_ prefix) of the override to update. Must belong to the caller's tenant; otherwise the mutation returns a not-found error.
Patch to apply. Only fields present in the input are changed.
Delete a customer price override. Requires customerPriceOverride:delete permission.
Arguments (1)
TypeID (cpo_ prefix) of the override to delete. Deletion is permanent; deleting an id that is absent from the caller's tenant returns not-found.
Create or update an operation cost mapping. Requires costcategory:write permission.
Arguments (1)
The mapping to write. When id is present the existing mapping is fully replaced from these fields; when absent a new mapping is created.
Create a new operation cost mapping. Requires costcategory:write permission.
Arguments (1)
Attributes of the new mapping. The id is server-assigned; isActive defaults to true when omitted.
Update an operation cost mapping. Only provided fields are changed. Requires costcategory:write permission.
Arguments (2)
TypeID of the mapping to update ("ocm_01K…"). Must belong to the calling tenant, otherwise the mutation returns a not-found error.
The fields to change; omitted fields keep their current values.
Delete an operation cost mapping. Requires costcategory:delete permission.
Arguments (1)
TypeID of the mapping to delete ("ocm_01K…"). Must belong to the calling tenant; deleting an unknown id returns a not-found error rather than succeeding silently.
Create or update a price bracket. Requires priceBracket:write permission.
Arguments (1)
Price bracket data
Create a new price bracket. Requires priceBracket:write permission.
Arguments (1)
Price bracket data
Update a price bracket. Only provided fields are changed. Requires priceBracket:write permission.
Arguments (2)
Price bracket ID to update
Fields to update — only provided fields are changed
Delete a price bracket. Requires priceBracket:delete permission.
Arguments (1)
Price bracket ID to delete
Create a production cell, or fully overwrite an existing one when input.id names one in the caller's tenant. Requires productionCell:write permission.
Arguments (1)
The production cell to create or fully overwrite.
Create a new production cell. Requires productionCell:write permission.
Arguments (1)
The production cell to create.
Update a production cell. Only provided fields are changed. Requires productionCell:write permission.
Arguments (2)
TypeID (prefix "pcl") of the production cell to update.
The fields to change; omitted fields are left as they are.
Delete a production cell. Work centers in the cell are kept but become ungrouped, and schedule scenarios targeting it lose that target. Requires productionCell:delete permission.
Arguments (1)
TypeID (prefix "pcl") of the production cell to delete.
Record an actual cost incurred. Requires recordedcost:write permission.
Arguments (1)
Recorded cost data
Create a new recorded cost. Requires recordedcost:write permission.
Arguments (1)
Recorded cost data
Update a recorded cost. Only provided fields are changed. Requires recordedcost:write permission.
Arguments (2)
Recorded cost ID to update
Fields to update — only provided fields are changed
Delete a recorded cost. Requires recordedcost:delete permission.
Arguments (1)
Recorded cost ID to delete
Create or update a tax code. Requires taxCode:write permission.
Arguments (1)
Tax code data
Create a new tax code. Requires taxCode:write permission.
Arguments (1)
Tax code data
Update a tax code. Only provided fields are changed. Requires taxCode:write permission.
Arguments (2)
Tax code ID to update
Fields to update — only provided fields are changed
Delete a tax code. Requires taxCode:delete permission.
Referenced by (0)
Exact type SDL
type Mutation {
"""
Register or update an integration's identity without changing record origin or IaC management.
"""
adoptIntegrationIdentity(
"""Identity to register for one existing record."""
input: AdoptIntegrationIdentityInput!
): AdoptIntegrationIdentityPayload! @topic(names: ["integrations"])
"""Saves the units section. Other sections are untouched."""
updateUnitSettings(
"""The new unit settings."""
input: UnitSettingsInput!
): UpdateUnitSettingsPayload! @topic(names: ["admin"])
"""Saves the time section. Other sections are untouched."""
updateTimeSettings(
"""The new time settings."""
input: TimeSettingsInput!
): UpdateTimeSettingsPayload! @topic(names: ["admin"])
"""Saves the production board section. Other sections are untouched."""
updateProductionBoardSettings(
"""The new production board settings."""
input: ProductionBoardSettingsInput!
): UpdateProductionBoardSettingsPayload! @topic(names: ["admin"])
"""Saves the app access section. Other sections are untouched."""
updateAppAccessSettings(
"""The new app access settings."""
input: AppAccessSettingsInput!
): UpdateAppAccessSettingsPayload! @topic(names: ["admin"])
"""Saves the status rules section. Other sections are untouched."""
updateStatusRuleSettings(
"""The new status rule settings."""
input: StatusRuleSettingsInput!
): UpdateStatusRuleSettingsPayload! @topic(names: ["admin"])
"""Saves the tool invocations section. Other sections are untouched."""
updateToolInvocationSettings(
"""The new tool invocation settings."""
input: ToolInvocationSettingsInput!
): UpdateToolInvocationSettingsPayload! @topic(names: ["admin"])
"""
Saves the time tracking section: the labour cost category logged time is costed in. Other sections are untouched; existing entries are never re-costed.
"""
updateTimeTrackingSettings(
"""The new time tracking settings."""
input: TimeTrackingSettingsInput!
): UpdateTimeTrackingSettingsPayload! @topic(names: ["admin"])
"""Saves the quoting section. Other sections are untouched."""
updateQuotingSettings(
"""The new quoting settings."""
input: QuotingSettingsInput!
): UpdateQuotingSettingsPayload! @topic(names: ["admin"])
"""Saves the machine-learning section. Other sections are untouched."""
updateMachineLearningSettings(
"""The new machine-learning settings."""
input: MachineLearningSettingsInput!
): UpdateMachineLearningSettingsPayload! @topic(names: ["admin"])
"""
Saves the ML experiment retention section. Other sections are untouched. A lower value applies to existing runs and experiments within the hour and cannot be undone.
"""
updateMLExperimentSettings(
"""The new ML experiment retention settings."""
input: MLExperimentSettingsInput!
): UpdateMLExperimentSettingsPayload! @topic(names: ["admin"])
"""
Append a plain text comment to a proposed or applied Change Request. Retry the same id and body after a lost response.
"""
iacAddChangeComment(
"""Owning stack."""
stackId: IaCStackID!
"""Change Request being discussed."""
changeId: IaCChangeID!
"""Client-generated comment id (cmt_…); reuse it to retry safely."""
id: IaCCommentID!
"""Plain-text comment, 1 to 16 KiB."""
body: String!
): IaCChangeComment! @topic(names: ["admin"])
"""Immediately delete a working branch with expected-head protection."""
iacGitDeleteWorkingRef(
"""Owning stack."""
stackId: IaCStackID!
"""Working branch to delete; main is protected."""
name: String!
"""Expected current commit."""
expected: String!
): IaCGitStageValue! @topic(names: ["admin"])
"""
Stage immutable objects without changing branch refs or deployed configuration.
"""
iacGitStage(
"""Owning stack."""
stackId: IaCStackID!
"""Hash-verified immutable objects; at most 1 MiB decoded per batch."""
objects: [IaCGitObjectInput!]!
): IaCGitStageValue! @topic(names: ["admin"])
"""
Compare and update a working branch; never publishes main or applies configuration.
"""
iacGitUpdateWorkingRef(
"""Owning stack."""
stackId: IaCStackID!
"""Working branch; protected main is rejected."""
name: String!
"""Expected current commit; null means the branch must not exist."""
expected: String
"""
Fully staged valid commit history; must fast-forward an existing branch.
"""
target: String!
): IaCGitRefValue! @topic(names: ["admin"])
"""
Rename a draft proposal without altering source, state, or approval. Requires stack authoring access.
"""
iacGitRenameChange(
"""Owning stack."""
stackId: IaCStackID!
"""Draft Change Request to rename."""
id: IaCChangeID!
"""New title, at most 255 UTF-8 bytes."""
title: String!
"""Previously read title; protects concurrent edits."""
expectedTitle: String!
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Replace a draft Change Request's description. Only its author may do this.
"""
iacGitUpdateChangeDescription(
"""Owning stack."""
stackId: IaCStackID!
"""Draft Change Request whose description changes."""
id: IaCChangeID!
"""New description, at most 64 KiB; may be empty."""
description: String!
"""Previously read description; protects concurrent edits."""
expectedDescription: String!
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Close a draft Change Request without applying it. Allowed for its author and for anyone who may apply the stack; the conversation stays readable.
"""
iacCancelChange(
"""Owning stack."""
stackId: IaCStackID!
"""Draft Change Request to cancel."""
id: IaCChangeID!
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Capture an immutable draft Change Request; no client-supplied plan is trusted or applied.
"""
iacGitCreateChange(
"""Owning stack."""
stackId: IaCStackID!
"""Short title of the proposed change; required."""
title: String!
"""Optional explanation of why the change is needed, at most 64 KiB."""
description: String
"""Working branch to capture."""
sourceRef: String!
"""Expected source commit, preventing accidental capture of newer edits."""
expected: String!
"""
Require main to match expectedMain atomically; true with null expectedMain requires an empty repository.
"""
checkExpectedMain: Boolean
"""Expected main commit when checkExpectedMain is true."""
expectedMain: String
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Capture the Change Request branch's pushed head as its next revision, keeping the conversation. Returns the Change Request unchanged when the branch has no new commits.
"""
iacGitReviseChange(
"""Owning stack."""
stackId: IaCStackID!
"""Draft Change Request to revise."""
id: IaCChangeID!
"""
The revision the caller last saw; a different current revision is refused with REVISION_CHANGED.
"""
expectedRevision: Int!
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Privately prepare an exact plan without publishing source or creating a change. Expires after 30 minutes; only its creator may publish it.
"""
iacPrepareChange(
"""Owning stack."""
stackId: IaCStackID!
"""Private immutable source objects, commit and expected base as JSON."""
source: String!
"""Existing review to revise only when this preparation is published."""
changeId: IaCChangeID
"""Expected current revision of the existing review."""
expectedRevision: Int
"""Description used only when this preparation is published."""
title: String!
"""Optional review context."""
description: String
"""Optional repository-relative project target."""
target: String
"""Bypass immutable content caches for this plan and its apply recheck."""
fullRefresh: Boolean
): IaCHostedValue! @topic(names: ["admin"])
"""
Publish a confirmed preparation as a change request and reviewed plan. Repeating publication returns the same change; stack review rules still gate apply.
"""
iacPublishPreparedChange(
"""Owning stack."""
stackId: IaCStackID!
"""Private preparation created by the current user."""
planId: IaCPlanID!
"""Exact plan digest confirmed by the user."""
digest: String!
): IaCHostedValue! @topic(names: ["admin"])
"""Produce a trusted server plan without applying resources."""
iacPlanChange(
"""Owning stack."""
stackId: IaCStackID!
"""Immutable Change Request to plan."""
changeId: IaCChangeID!
"""
Optional repository-relative target; otherwise use the project manifest.
"""
target: String
"""Bypass immutable content caches for this plan and its apply recheck."""
fullRefresh: Boolean
"""
Private variable source, encrypted with the plan and never committed to Git.
"""
variables: String
): IaCHostedValue! @topic(names: ["admin"])
"""
Atomically Apply the reviewed plan as the actual user, publishing main only on success. The stack's rules must be met (REVIEW_REQUIRED, CHANGES_REQUESTED) unless a stack admin bypasses them.
"""
iacApplyChange(
"""Owning stack."""
stackId: IaCStackID!
"""Server-produced plan reviewed by this user."""
planId: IaCPlanID!
"""Exact digest approved by this user; stale plans fail closed."""
digest: String!
"""
Apply without meeting the stack's rules, recording this reason (at most 2 KiB). Only stack admins, and only when the rules allow bypass (otherwise BYPASS_NOT_ALLOWED). A blank reason is no bypass.
"""
bypassReason: String
): IaCHostedValue! @topic(names: ["admin"])
"""Coordinator-only state capability; unavailable to ordinary clients."""
iacHostedState(
"""Owning stack."""
stackId: IaCStackID!
"""Internal host capability."""
method: String!
"""Internal JSON protocol input; requires server-held authority."""
input: String!
): IaCHostedValue! @topic(names: ["admin"])
"""Update authoring presence without changing source or deployment state."""
iacUpdateEditing(
"""Stack id (stk_…)."""
stackId: IaCStackID!
"""Versioned editing presence update JSON."""
update: String!
"""Start the editing session before updates."""
enter: Boolean
): IaCHostedValue! @topic(names: ["admin"])
"""End an authoring presence session."""
iacLeaveEditing(
"""Stack id (stk_…)."""
stackId: IaCStackID!
"""Editing session to leave."""
sessionId: IaCEditingSessionID!
): IaCHostedValue! @topic(names: ["admin"])
"""
Atomically create an absent stack and import legacy state. Requires tenant administration; exact retries are idempotent.
"""
iacMigrateStack(
"""Deployment environment assertion."""
environment: String!
"""Legacy stack name; default for an unnamed project."""
name: String!
"""Complete legacy snapshot JSON for one-time import."""
snapshot: String!
): IaCStackValue! @topic(names: ["admin"])
"""Create a hosted Git stack."""
iacCreateStack(
"""Deployment environment assertion."""
environment: String!
"""Unique stack name."""
name: String!
"""Human-readable stack name."""
displayName: String!
"""Owning team; unassigned stacks require tenant administration."""
ownerTeamId: TeamID
): IaCStackValue! @topic(names: ["admin"])
"""
Configure stack ownership and archival under stack administration permissions.
"""
iacConfigureStack(
"""Stack id (stk_…)."""
stackId: IaCStackID!
"""New owning team."""
ownerTeamId: TeamID
"""Whether the stack is read-only."""
archived: Boolean
"""Explicitly remove the owning team."""
clearOwnerTeam: Boolean
): IaCStackUpdateResult! @topic(names: ["admin"])
"""Manage stack grants; grants never bypass resource permissions."""
iacGrantStack(
"""Stack id (stk_…)."""
stackId: IaCStackID!
"""Team receiving access."""
teamId: TeamID!
"""read, write, execute or admin; omitted removes the grant."""
access: String
): IaCStackUpdateResult! @topic(names: ["admin"])
"""
Write a new version of a stack secret; earlier versions are kept. Plans made before it need re-planning. Requires stack administration.
"""
iacSetStackSecret(
"""Owning stack."""
stackId: IaCStackID!
"""
Secret name: a letter or underscore, then letters, digits or underscores; at most 128 characters.
"""
name: String!
"""Secret value, at most 64 KiB. Stored encrypted and never returned."""
value: String!
): IaCStackSecret! @topic(names: ["admin"])
"""
Mark a stack secret deleted by writing a deleted version; earlier versions are kept for audit. True when the secret was deleted. Requires stack administration.
"""
iacDeleteStackSecret(
"""Owning stack."""
stackId: IaCStackID!
"""Secret to delete."""
name: String!
): Boolean! @topic(names: ["admin"])
"""
Irreversibly destroy stored secret values, for example after a leak. Metadata stays; plans that used a purged version must be re-planned. Requires stack administration.
"""
iacPurgeStackSecret(
"""Owning stack."""
stackId: IaCStackID!
"""Secret whose stored values are destroyed."""
name: String!
"""Version to purge; omitted purges every version."""
version: Int
): IaCStackSecret! @topic(names: ["admin"])
"""
Seed a stack's non-sensitive values once, when it has none (otherwise VALUES_EXIST); every later change is a reviewed values change. Requires stack administration.
"""
iacImportStackValues(
"""Owning stack."""
stackId: IaCStackID!
"""Non-sensitive values to seed, each name once."""
values: [IaCValueInput!]!
): [IaCStackVariable!]! @topic(names: ["admin"])
"""
Propose new stack values as a values change: a Change Request on refs/cococo/values that plans main's source with the proposed values and is reviewed, gated and applied like any change. One open values change per stack (CHANGE_EXISTS). Secrets are refused with VALUE_SENSITIVITY_MISMATCH.
"""
iacProposeValuesChange(
"""Owning stack; it must have a main (an applied change)."""
stackId: IaCStackID!
"""
Short title of the values change; required, one line, at most 255 bytes.
"""
title: String!
"""Values to set, each name once."""
set: [IaCValueInput!]!
"""Names whose current value the change removes."""
unset: [String!]!
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Change a stack's rules. Every change is recorded. Requires stack administration; invalid values are refused with INVALID_RULES.
"""
iacUpdateStackRules(
"""Stack whose rules change."""
stackId: IaCStackID!
"""Approvals required, 0 to 10; omitted leaves it unchanged."""
requiredApprovals: Int
"""
Count only owning-team approvals; needs an owning team. Omitted leaves it unchanged.
"""
ownerTeamApprovalsOnly: Boolean
"""
Dismiss approvals when a revision changes content; omitted leaves it unchanged.
"""
dismissApprovalsOnRevision: Boolean
"""
Let stack admins apply without meeting the rules; omitted leaves it unchanged.
"""
allowAdminBypass: Boolean
"""
The updatedAt last read; omit when no rules were set. A different current value is refused with RULES_CHANGED.
"""
expectedUpdatedAt: String
): IaCStackRules! @topic(names: ["admin"])
"""
Give a verdict on the current revision; it replaces your earlier verdict on that revision. The Change Request's author and anyone who captured a revision cannot approve (SELF_APPROVAL). Requires stack write access.
"""
iacReviewChange(
"""Owning stack."""
stackId: IaCStackID!
"""Draft Change Request to review."""
changeId: IaCChangeID!
"""
The revision reviewed; anything but the current revision is refused with REVISION_CHANGED.
"""
revision: Int!
"""Approve, or request changes."""
verdict: IaCReviewVerdict!
"""Optional plain-text note, up to 16 KiB, shown in the timeline."""
body: String
): IaCGitChangeValue! @topic(names: ["admin"])
"""
Withdraw your own review, or, as a stack admin, dismiss someone else's with a reason. Recorded in the timeline.
"""
iacDismissReview(
"""Owning stack."""
stackId: IaCStackID!
"""Review to dismiss."""
reviewId: IaCReviewID!
"""Why; required when dismissing someone else's review."""
reason: String
): IaCGitChangeValue! @topic(names: ["admin"])
"""Create or update a job. Requires job:write permission."""
upsertJob(
"""Job data"""
input: UpsertJobInput!
): UpsertJobPayload! @topic(names: ["jobs"])
"""Create a new job. Requires job:write permission."""
createJob(
"""Job data"""
input: CreateJobInput!
): UpsertJobPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.create-job"])
"""
Update a job. Only provided fields are changed. Requires job:write permission.
"""
updateJob(
"""Job ID to update"""
id: JobID!
"""Fields to update — only provided fields are changed"""
input: UpdateJobInput!
): UpsertJobPayload! @topic(names: ["jobs"])
"""Delete a job. Requires job:delete permission."""
deleteJob(
"""Job to delete"""
input: DeleteJobInput!
): DeleteJobPayload! @topic(names: ["jobs"])
"""
Atomically replace or clear a job assembly graph. Validates job membership, cycles, containers and sibling precedence. Requires job:write, job:read and component:read. Inferred edges are saved only when explicitly supplied by the caller.
"""
replaceJobAssembly(
"""
Whole explicit graph, ordered list or nested members, plus the expected graph revision.
"""
input: ReplaceJobAssemblyInput!
): ReplaceJobAssemblyPayload! @topic(names: ["jobs"])
"""Create a new job group. Requires jobGroup:write permission."""
createJobGroup(
"""Job group data"""
input: CreateJobGroupInput!
): JobGroupPayload! @topic(names: ["jobs"])
"""
Add a new job to a group by instantiating the group's template. Requires jobGroup:write permission.
"""
addJobToJobGroup(
"""Job to add"""
input: AddJobToJobGroupInput!
): AddJobToJobGroupPayload! @topic(names: ["jobs"])
"""
Remove a job from its group (job survives). Requires jobGroup:write permission.
"""
removeJobFromJobGroup(
"""Job to remove"""
input: RemoveJobFromJobGroupInput!
): RemoveJobFromJobGroupPayload! @topic(names: ["jobs"])
"""
Delete a job group (jobs are unlinked, not deleted). Requires jobGroup:delete permission.
"""
destroyJobGroup(
"""Job group to destroy"""
input: DestroyJobGroupInput!
): DestroyJobGroupPayload! @topic(names: ["jobs"])
"""
Delete a job group and all its jobs. Requires jobGroup:delete permission.
"""
destroyJobGroupAndJobs(
"""Job group to destroy with all jobs"""
input: DestroyJobGroupInput!
): DestroyJobGroupPayload! @topic(names: ["jobs"])
"""Create a batch; validates tenant, scope and references"""
createBatch(
"""Record fields"""
input: CreateBatchInput!
): BatchPayload! @topic(names: ["jobs"])
"""Update a batch; validates tenant, scope and references"""
updateBatch(
"""Identifier to update"""
id: BatchID!
"""Record fields"""
input: UpdateBatchInput!
): BatchPayload! @topic(names: ["jobs"])
"""Delete a batch; validates tenant, scope and references"""
deleteBatch(
"""Identifier to delete"""
input: DeleteBatchInput!
): DeleteBatchPayload! @topic(names: ["jobs"])
"""Create a batchComponent; validates tenant, scope and references"""
createBatchComponent(
"""Record fields"""
input: CreateBatchComponentInput!
): BatchComponentPayload! @topic(names: ["jobs"])
"""Update a batchComponent; validates tenant, scope and references"""
updateBatchComponent(
"""Identifier to update"""
id: BatchComponentID!
"""Record fields"""
input: UpdateBatchComponentInput!
): BatchComponentPayload! @topic(names: ["jobs"])
"""Delete a batchComponent; validates tenant, scope and references"""
deleteBatchComponent(
"""Identifier to delete"""
input: DeleteBatchComponentInput!
): DeleteBatchComponentPayload! @topic(names: ["jobs"])
"""Create a batchContribution; validates tenant, scope and references"""
createBatchContribution(
"""Record fields"""
input: CreateBatchContributionInput!
): BatchContributionPayload! @topic(names: ["jobs"])
"""Update a batchContribution; validates tenant, scope and references"""
updateBatchContribution(
"""Identifier to update"""
id: BatchContributionID!
"""Record fields"""
input: UpdateBatchContributionInput!
): BatchContributionPayload! @topic(names: ["jobs"])
"""Delete a batchContribution; validates tenant, scope and references"""
deleteBatchContribution(
"""Identifier to delete"""
input: DeleteBatchContributionInput!
): DeleteBatchContributionPayload! @topic(names: ["jobs"])
"""
Delegate job work to batch component work, or clear an unexecuted assignment.
"""
setOperationProducer(
"""Original work and its batch producer."""
input: SetOperationProducerInput!
): DelegatedWorkPayload! @topic(names: ["jobs"])
"""
Complete delegated job work from finished producer evidence without duplicate machine metrics or production receipts.
"""
fulfilDelegatedWork(
"""Source-specific full fulfilment confirmation."""
input: FulfilDelegatedWorkInput!
): DelegatedWorkPayload! @topic(names: ["jobs"])
"""
Create or update a product template. Requires productTemplate:write permission.
"""
upsertProductTemplate(
"""Template data"""
input: UpsertProductTemplateInput!
): UpsertProductTemplatePayload! @topic(names: ["productTemplates"])
"""
Create a new product template. Requires productTemplate:write permission.
"""
createProductTemplate(
"""Template data"""
input: CreateProductTemplateInput!
): UpsertProductTemplatePayload! @topic(names: ["productTemplates"])
"""
Update a product template. Only provided fields are changed. Requires productTemplate:write permission.
"""
updateProductTemplate(
"""Product template ID to update"""
id: ProductTemplateID!
"""Fields to update — only provided fields are changed"""
input: UpdateProductTemplateInput!
): UpsertProductTemplatePayload! @topic(names: ["productTemplates"])
"""Delete a product template. Requires productTemplate:delete permission."""
deleteProductTemplate(
"""Template to delete"""
input: DeleteProductTemplateInput!
): DeleteProductTemplatePayload! @topic(names: ["productTemplates"])
"""
Publish a product template version. Requires productTemplate:write permission.
"""
publishProductTemplate(
"""Template to publish"""
input: PublishProductTemplateInput!
): PublishProductTemplatePayload! @topic(names: ["productTemplates"])
"""Create or update a milestone. Requires milestone:write permission."""
upsertMilestone(
"""Milestone data"""
input: UpsertMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""Create a new milestone. Requires milestone:write permission."""
createMilestone(
"""Milestone data"""
input: CreateMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""
Update a milestone. Only provided fields are changed. Requires milestone:write permission.
"""
updateMilestone(
"""Milestone ID to update"""
id: MilestoneID!
"""Fields to update — only provided fields are changed"""
input: UpdateMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""
Mark a milestone as started now. Does not change its completion. Requires milestone:write permission.
"""
startMilestone(
"""Milestone to start"""
input: CompleteMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""Clear a milestone's start. Requires milestone:write permission."""
unstartMilestone(
"""Milestone to unstart"""
input: CompleteMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""Mark a milestone as completed. Requires milestone:write permission."""
completeMilestone(
"""Milestone to complete"""
input: CompleteMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""
Mark a milestone as not completed. Requires milestone:write permission.
"""
uncompleteMilestone(
"""Milestone to uncomplete"""
input: CompleteMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""
Mark a milestone as cancelled, optionally recording a reason. Requires milestone:write permission.
"""
cancelMilestone(
"""Milestone to cancel, with optional reason"""
input: CancelMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""
Clear the cancellation state of a milestone. Requires milestone:write permission.
"""
uncancelMilestone(
"""Milestone to uncancel"""
input: CompleteMilestoneInput!
): MilestonePayload! @topic(names: ["jobs"])
"""Delete a milestone. Requires milestone:delete permission."""
deleteMilestone(
"""Milestone to delete"""
input: DeleteMilestoneInput!
): DeletePayload! @topic(names: ["jobs"])
"""Create or update a component. Requires component:write permission."""
upsertComponent(
"""Component data"""
input: UpsertComponentInput!
): UpsertComponentPayload! @topic(names: ["jobs"])
"""Create a new component. Requires component:write permission."""
createComponent(
"""Component data"""
input: CreateComponentInput!
): UpsertComponentPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.add-cover"])
"""
Update a component. Only provided fields are changed. Requires component:write permission.
"""
updateComponent(
"""Component ID to update"""
id: ComponentID!
"""Fields to update — only provided fields are changed"""
input: UpdateComponentInput!
): UpsertComponentPayload! @topic(names: ["jobs"])
"""Delete a component. Requires component:delete permission."""
deleteComponent(
"""Component to delete"""
input: DeleteComponentInput!
): DeleteComponentPayload! @topic(names: ["jobs"])
"""
Create or update a component section. Requires componentGroup:write permission.
"""
upsertComponentGroup(
"""Component section data"""
input: UpsertComponentGroupInput!
): UpsertComponentGroupPayload! @topic(names: ["jobs"])
"""
Create a new component section. Requires componentGroup:write permission.
"""
createComponentGroup(
"""Component section data"""
input: CreateComponentGroupInput!
): UpsertComponentGroupPayload! @topic(names: ["jobs"])
"""
Update a component section. Only provided fields are changed. Requires componentGroup:write permission.
"""
updateComponentGroup(
"""Component section ID to update"""
id: ComponentGroupID!
"""Fields to update — only provided fields are changed"""
input: UpdateComponentGroupInput!
): UpsertComponentGroupPayload! @topic(names: ["jobs"])
"""Delete a component section. Requires componentGroup:delete permission."""
deleteComponentGroup(
"""Component section to delete"""
input: DeleteComponentGroupInput!
): DeleteComponentGroupPayload! @topic(names: ["jobs"])
"""Create or update an operation. Requires operation:write permission."""
upsertOperation(
"""Operation data"""
input: UpsertOperationInput!
): UpsertOperationPayload! @topic(names: ["jobs"])
"""Create a new operation. Requires operation:write permission."""
createOperation(
"""Operation data"""
input: CreateOperationInput!
): UpsertOperationPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.add-press-operation"])
"""
Update an operation. Only provided fields are changed. Requires operation:write permission.
"""
updateOperation(
"""Operation ID to update"""
id: OperationID!
"""Fields to update — only provided fields are changed"""
input: UpdateOperationInput!
): UpsertOperationPayload! @topic(names: ["jobs"])
"""
Transition operation to a new status. Requires operation:execute permission.
"""
transitionOperation(
"""Operation and target status"""
input: TransitionOperationInput!
): TransitionOperationPayload! @topic(names: ["jobs"])
"""Delete an operation. Requires operation:delete permission."""
deleteOperation(
"""Operation to delete"""
input: DeleteOperationInput!
): DeleteOperationPayload! @topic(names: ["jobs"])
"""Create or update a script. Requires script:write permission."""
upsertScript(
"""Script data"""
input: UpsertScriptInput!
): UpsertScriptPayload! @topic(names: ["scripting"])
"""Create a new script. Requires script:write permission."""
createScript(
"""Script data"""
input: CreateScriptInput!
): UpsertScriptPayload! @topic(names: ["scripting"])
"""
Update a script. Only provided fields are changed. Requires script:write permission.
"""
updateScript(
"""Script ID to update"""
id: ScriptID!
"""Fields to update — only provided fields are changed"""
input: UpdateScriptInput!
): UpsertScriptPayload! @topic(names: ["scripting"])
"""
Put an old version's source back on the script. Appends a new version rather than rewinding history. The name and role are not restored, only the source. Requires script:write permission.
"""
restoreScriptVersion(
"""Script to restore"""
scriptId: ScriptID!
"""Version whose source to put back"""
version: Int!
): RestoreScriptVersionPayload! @topic(names: ["scripting"])
"""Delete a script. Requires script:delete permission."""
deleteScript(
"""ID of the script to delete"""
id: ScriptID!
): DeletePayload! @topic(names: ["scripting"])
"""
Create or update a service account. Only BOT accounts are writable through the API — HUMAN users are provisioned by Control and are read-only here. Requires user:write permission.
"""
upsertUser(
"""User data"""
input: UpsertUserInput!
): UpsertUserPayload! @topic(names: ["admin", "iam"])
"""
Create a new service account. The created user is always a BOT — HUMAN users are provisioned by Control. Requires user:write permission.
"""
createUser(
"""User data"""
input: CreateUserInput!
): UpsertUserPayload! @topic(names: ["admin", "iam"])
"""
Update a service account. Only provided fields are changed. HUMAN accounts are provisioned by Control and cannot be updated. Requires user:write permission.
"""
updateUser(
"""User ID to update"""
id: UserID!
"""Fields to update — only provided fields are changed"""
input: UpdateUserInput!
): UpsertUserPayload! @topic(names: ["admin", "iam"])
"""
Delete a service account. HUMAN accounts are provisioned by Control and cannot be deleted here. Requires user:delete permission.
"""
deleteUser(
"""User ID to delete"""
id: UserID!
): DeletePayload! @topic(names: ["admin", "iam"])
"""
Attach a conditional policy for IaC ownership; an existing attachment must be imported.
"""
createConditionalIAMPolicyAttachment(
"""User and policy to attach"""
input: AttachPolicyInput!
): ConditionalIAMPolicyAttachmentPayload! @topic(names: ["admin"])
"""
Attach a policy for IaC ownership; an existing attachment must be imported.
"""
createIAMPolicyAttachment(
"""User and policy to attach"""
input: AttachPolicyInput!
): IAMPolicyAttachmentPayload! @topic(names: ["admin"])
"""Detach the policy without deleting its user or policy."""
deleteIAMPolicyAttachment(
"""Policy attachment identifier"""
id: UserPolicyAttachmentID!
): DetachPolicyPayload! @topic(names: ["admin"])
"""
Create an IAM policy and return its revision. Requires iam:createPolicy permission.
"""
createConditionalIAMPolicy(
"""Policy data"""
input: CreateIAMPolicyInput!
): ConditionalIAMPolicyPayload! @topic(names: ["admin"])
"""
Update an IAM policy, refusing the change if it was edited since expectedRevision. Requires iam:updatePolicy permission.
"""
updateConditionalIAMPolicy(
"""IAM policy ID to update"""
id: IAMPolicyID!
"""Policy update data; expectedRevision is required"""
input: UpdateIAMPolicyInput!
): ConditionalIAMPolicyPayload! @topic(names: ["admin"])
"""Create an IAM policy. Requires iam:createPolicy permission."""
createIAMPolicy(
"""Policy data"""
input: CreateIAMPolicyInput!
): IAMPolicyPayload! @topic(names: ["admin"])
"""Update an IAM policy. Requires iam:updatePolicy permission."""
updateIAMPolicy(
"""IAM policy ID to update"""
id: IAMPolicyID!
"""Policy update data"""
input: UpdateIAMPolicyInput!
): IAMPolicyPayload! @topic(names: ["admin"])
"""Delete an IAM policy. Requires iam:deletePolicy permission."""
deleteIAMPolicy(
"""Policy ID to delete"""
id: IAMPolicyID!
): DeletePayload! @topic(names: ["admin"])
"""Attach a policy to a user. Requires iam:attachPolicy permission."""
attachPolicy(
"""Attachment data"""
input: AttachPolicyInput!
): AttachPolicyPayload! @topic(names: ["admin"])
"""Detach a policy from a user. Requires iam:detachPolicy permission."""
detachPolicy(
"""Detachment data"""
input: DetachPolicyInput!
): DetachPolicyPayload! @topic(names: ["admin"])
"""Create a new workflow. Requires workflow:write permission."""
createWorkflow(
"""Workflow data"""
input: CreateWorkflowInput!
): WorkflowPayload! @topic(names: ["workflows"])
"""Update an existing workflow. Requires workflow:write permission."""
updateWorkflow(
"""Workflow ID to update"""
id: WorkflowID!
"""Workflow update data"""
input: UpdateWorkflowInput!
): WorkflowPayload! @topic(names: ["workflows"])
"""
Delete a workflow and all its versions. Requires workflow:delete permission.
"""
deleteWorkflow(
"""Workflow ID to delete"""
id: WorkflowID!
): DeleteWorkflowPayload! @topic(names: ["workflows"])
"""
Delete one version from a workflow's authoring history. Fails when the workflow is active and this is the version it runs — deactivate it or activate another version first. Requires workflow:delete permission.
"""
deleteWorkflowVersion(
"""TypeID of the workflow version to delete."""
id: WorkflowVersionID!
): DeletePayload! @topic(names: ["workflows"])
"""
Idempotent workflow version cleanup; retains the active-version protection
"""
deleteWorkflowVersionIfExists(
"""Version to remove, or confirm already removed by parent deletion"""
id: WorkflowVersionID!
): DeletePayload! @topic(names: ["workflows"])
"""
Create an immutable workflow version from XML; validation is shared with all authoring paths. Does not activate it.
"""
createWorkflowVersionFromSource(
"""
Parent workflow and XML source to compile, validate and save as a new version
"""
input: CreateWorkflowVersionFromSourceInput!
): WorkflowVersionSourcePayload! @topic(names: ["workflows"])
"""
Create a new version of a workflow. Requires workflow:write permission.
"""
createWorkflowVersion(
"""Version data"""
input: CreateWorkflowVersionInput!
): WorkflowVersionPayload! @topic(names: ["workflows"])
"""
Set the active version of a workflow. Requires workflow:write permission.
"""
setActiveVersion(
"""Workflow ID"""
workflowId: WorkflowID!
"""Version ID to set as active (null to unset)"""
versionId: WorkflowVersionID
): SetActiveVersionPayload! @topic(names: ["workflows"])
"""
Export a workflow version to YAML or JSON. Requires workflow:read permission.
"""
exportWorkflow(
"""Export parameters"""
input: ExportWorkflowInput!
): ExportWorkflowPayload! @topic(names: ["workflows"])
"""
Import a workflow from YAML or JSON, creating a new version. Requires workflow:write permission.
"""
importWorkflow(
"""Import parameters"""
input: ImportWorkflowInput!
): ImportWorkflowPayload! @topic(names: ["workflows"])
"""
Validate a workflow definition without importing it. Requires workflow:read permission.
"""
validateWorkflow(
"""Validation parameters"""
input: ValidateWorkflowInput!
): ValidateWorkflowPayload! @topic(names: ["workflows"])
"""
Delete a journey version using native authorization, succeeding when it is already absent for parent-owned cascade cleanup.
"""
deleteJourneyVersionIfExists(
"""
Journey version to remove; absence is treated as successful idempotent cleanup.
"""
id: JourneyVersionID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Compile authoritative Journey XML and create a journey using native scope-dependent authorization.
"""
createJourneyFromSource(
"""
Journey XML plus optional visibility and team assignments to validate and create.
"""
input: CreateJourneySourceInput!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Apply a revision-checked Journey XML or visibility edit while preserving fields omitted by the caller.
"""
updateJourneyFromSource(
"""Existing journey to edit within the current tenant."""
id: JourneyID!
"""
Observed revision and replacement source, scope or teams; omitted optional edits are retained.
"""
input: UpdateJourneySourceInput!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Compile Journey XML into a new draft version under an existing journey, preserving prior versions.
"""
createJourneyVersionFromSource(
"""Parent journey and authoritative XML for the new draft version."""
input: CreateJourneyVersionSourceInput!
): JourneyVersionPayload! @topic(names: ["surfaces"])
"""
Create a journey or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
"""
upsertJourney(
"""
The journey document plus its scope and team assignments. The definition's `id` (the handle) selects the journey to edit, or creates one if no journey in the tenant carries that handle.
"""
input: UpsertJourneyInput!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Create a new journey. PERSONAL is self-service; TEAM/INSTANCE require journey:write.
"""
createJourney(
"""
The journey document plus its scope and team assignments. Always creates a new journey with a single draft version; it never edits an existing one.
"""
input: CreateJourneyInput!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Patch an existing journey — only provided fields are changed. Owner for PERSONAL, else journey:write.
"""
updateJourney(
"""
TypeID of the journey to patch (prefix `jny`). This, not the definition's handle, identifies the record; the handle is never reassigned.
"""
id: JourneyID!
"""The aspects to change. Omitted fields leave the journey untouched."""
input: UpdateJourneyInput!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Promote a named draft version of a journey to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else journey:write.
"""
publishJourney(
"""TypeID of the journey to publish (prefix `jny`)."""
id: JourneyID!
"""
TypeID of the draft version to promote (prefix `jnv`). Fails with a field error when the version is unknown, belongs to another journey, or is not an open draft.
"""
versionId: JourneyVersionID!
): JourneyPayload! @topic(names: ["surfaces"])
"""
Create a new draft version of a journey. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else journey:write.
"""
createJourneyVersion(
"""The journey to extend and the definition for its new draft."""
input: CreateJourneyVersionInput!
): JourneyVersionPayload! @topic(names: ["surfaces"])
"""
Delete one version from a journey's authoring history. Fails when the version is the one the journey is currently published at — delete the journey itself to remove that. Owner for PERSONAL, else journey:write.
"""
deleteJourneyVersion(
"""TypeID of the journey version to delete (prefix `jnv`)."""
id: JourneyVersionID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Delete a journey and all its versions. Owner for PERSONAL, else journey:write.
"""
deleteJourney(
"""
TypeID of the journey to delete (prefix `jny`). Its versions and team assignments cascade-delete with it; the deletion is permanent.
"""
id: JourneyID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Create a workspace or overwrite its open draft. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
"""
upsertWorkspace(
"""
The definition (which carries the handle) plus optional scope / team assignments.
"""
input: UpsertWorkspaceInput!
): WorkspacePayload! @topic(names: ["surfaces"])
"""
Create a new workspace. PERSONAL is self-service; TEAM/INSTANCE require workspace:write.
"""
createWorkspace(
"""
The definition for the new workspace plus optional scope / team assignments.
"""
input: CreateWorkspaceInput!
): WorkspacePayload! @topic(names: ["surfaces"])
"""
Revision-checked Workspace authoring update using native authorization and validation.
"""
updateWorkspaceSource(
"""
Existing workspace whose authoring source or assignments will be edited.
"""
id: WorkspaceID!
"""
Observed revision and author-owned source or visibility edits, validated using native Workspace rules.
"""
input: UpdateWorkspaceInput!
): WorkspacePayload! @topic(names: ["surfaces"])
"""
Update a workspace. Only provided fields are changed. Owner for PERSONAL, else workspace:write.
"""
updateWorkspace(
"""TypeID of the workspace to update (prefix `wks`)."""
id: WorkspaceID!
"""Patch of the fields to change; omitted fields are left untouched."""
input: UpdateWorkspaceInput!
): WorkspacePayload! @topic(names: ["surfaces"])
"""
Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.
"""
invokeWorkspaceAction(
"""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"])
"""
Promote a named draft version of a workspace to the live published version. Other open drafts are left untouched. Owner for PERSONAL, else workspace:write.
"""
publishWorkspace(
"""TypeID of the workspace to publish (prefix `wks`)."""
id: WorkspaceID!
"""
TypeID of the draft version to promote (prefix `wsv`). Fails with a field error when the version is unknown, belongs to another workspace, or is not an open draft.
"""
versionId: WorkspaceVersionID!
): WorkspacePayload! @topic(names: ["surfaces"])
"""
Create an immutable source snapshot for reviewed publication. Parent edits create another draft instead of changing this version. Uses native Workspace authorization and validation.
"""
createWorkspaceVersionSnapshot(
"""
Parent workspace and reviewed source snapshot to persist as a new immutable draft version.
"""
input: CreateWorkspaceVersionInput!
): WorkspaceVersionPayload! @topic(names: ["surfaces"])
"""
Create a new draft version of a workspace. Always mints a new version rather than amending an open draft, so several drafts may be open at once. Owner for PERSONAL, else workspace:write.
"""
createWorkspaceVersion(
"""The workspace to extend and the definition for its new draft."""
input: CreateWorkspaceVersionInput!
): WorkspaceVersionPayload! @topic(names: ["surfaces"])
"""
Idempotent cleanup retaining native scope authorization and published-version protection
"""
deleteWorkspaceVersionIfExists(
"""Version to remove or confirm already removed by parent deletion"""
id: WorkspaceVersionID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Delete one version from a workspace's authoring history. Fails when the version is the one the workspace is currently published at — delete the workspace itself to remove that. Owner for PERSONAL, else workspace:write.
"""
deleteWorkspaceVersion(
"""TypeID of the workspace version to delete (prefix `wsv`)."""
id: WorkspaceVersionID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Delete a workspace and all its versions. Owner for PERSONAL, else workspace:write.
"""
deleteWorkspace(
"""
TypeID of the workspace to delete (prefix `wks`). Its versions and team assignments cascade.
"""
id: WorkspaceID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Create a Portal. Control allocates its generated address; retrying with the same idempotencyKey returns the same Portal.
"""
createPortal(
"""Configuration of the new Portal."""
input: CreatePortalInput!
): PortalPayload! @topic(names: ["surfaces"])
"""
Update a Portal's configuration. Omitted input fields keep their values.
"""
updatePortal(
"""Portal to update."""
id: PortalID!
"""Fields to change."""
input: UpdatePortalInput!
): PortalPayload! @topic(names: ["surfaces"])
"""
Delete a Portal with its sites, snapshots and Portal-scoped identity records. Tenant-wide PortalUsers are kept; deleting a missing Portal succeeds.
"""
deletePortal(
"""Portal to delete."""
id: PortalID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Replace a Portal's audience bindings, which choose the site each kind of visitor is served.
"""
setPortalAudiences(
"""Portal whose bindings to replace."""
id: PortalID!
"""Complete replacement list; [] removes every binding."""
audiences: [PortalAudienceInput!]!
"""
Optional stale-write check. Omit for standard atomic publication/binding semantics.
"""
expectedRevision: Int
): PortalPayload! @topic(names: ["surfaces"])
"""
Reserve a custom hostname for a Portal. Returns an expiring exclusive DNS TXT proof to publish before verifying.
"""
reservePortalDomain(
"""Portal the alias is for."""
portalId: PortalID!
"""Hostname and retry key of the reservation."""
input: ReservePortalDomainInput!
): PortalDomainPayload! @topic(names: ["surfaces"])
"""
Ask Control to check a reserved alias's TXT proof and, when it matches, begin HTTP-01 TLS issuance.
"""
verifyPortalDomain(
"""Portal the alias belongs to."""
portalId: PortalID!
"""
The `pdm_` reservation id returned by reservePortalDomain; a bare UUID is refused.
"""
reservationId: PortalDomainID!
): PortalDomainPayload! @topic(names: ["surfaces"])
"""
Read a custom alias's current status from Control and update the locally cached status. Changes no Portal configuration.
"""
refreshPortalDomain(
"""Portal the alias belongs to."""
portalId: PortalID!
"""
The `pdm_` reservation id returned by reservePortalDomain; a bare UUID is refused.
"""
reservationId: PortalDomainID!
): PortalDomain @topic(names: ["surfaces"])
"""
Create an empty site for a Portal. Publish a source version to make it servable.
"""
createPortalSite(
"""The new site."""
input: CreatePortalSiteInput!
): PortalSitePayload! @topic(names: ["surfaces"])
"""Update a site's settings. Omitted input fields keep their values."""
updatePortalSite(
"""Site to update."""
id: PortalSiteID!
"""Fields to change."""
input: UpdatePortalSiteInput!
): PortalSitePayload! @topic(names: ["surfaces"])
"""
Delete a site and its snapshots. Fails with CONFLICT while an audience binding still references it; deleting a missing site succeeds.
"""
deletePortalSite(
"""Site to delete."""
id: PortalSiteID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Store a new immutable source snapshot for a site. Each call creates an independent snapshot, even for identical source.
"""
createPortalSiteVersion(
"""Site and complete source files of the snapshot."""
input: CreatePortalSiteVersionInput!
): PortalSiteVersionPayload! @topic(names: ["surfaces"])
"""
Delete an unpublished source snapshot. The published snapshot cannot be deleted; deleting a missing one succeeds.
"""
deletePortalSiteVersion(
"""Snapshot to delete."""
id: PortalSiteVersionID!
): DeletePayload! @topic(names: ["surfaces"])
"""
Make a snapshot the site's served version and increment the site revision. Publishing an older snapshot rolls back.
"""
publishPortalSite(
"""Site to publish."""
siteId: PortalSiteID!
"""Snapshot of that site to serve."""
versionId: PortalSiteVersionID!
"""
Optional stale-write check. Omit for standard atomic publication/binding semantics.
"""
expectedRevision: Int
): PortalSitePayload! @topic(names: ["surfaces"])
"""
Create a tenant-wide PortalUser. Admit them to a Portal with createPortalMembership.
"""
createPortalUser(
"""The new user."""
input: CreatePortalUserInput!
): PortalUserPayload! @topic(names: ["surfaces"])
"""
Update a PortalUser. Omitted input fields keep their values; deactivation stops their authentication immediately.
"""
updatePortalUser(
"""PortalUser to update."""
id: PortalUserID!
"""Fields to change."""
input: UpdatePortalUserInput!
): PortalUserPayload! @topic(names: ["surfaces"])
"""
Revoke a PortalUser, immediately disabling their sessions and credentials. The record is kept for audit, not deleted.
"""
revokePortalUser(
"""PortalUser to revoke."""
id: PortalUserID!
): PortalUserPayload! @topic(names: ["surfaces"])
"""Admit a PortalUser to a Portal on behalf of a customer."""
createPortalMembership(
"""The new membership."""
input: CreatePortalMembershipInput!
): PortalMembershipPayload! @topic(names: ["surfaces"])
"""
Update a membership's roles, policy grants or activity. Changes apply to subsequent requests without reissuing credentials.
"""
updatePortalMembership(
"""Membership to update."""
id: PortalMembershipID!
"""Fields to change."""
input: UpdatePortalMembershipInput!
): PortalMembershipPayload! @topic(names: ["surfaces"])
"""
Revoke a membership, immediately disabling credentials that act through it. The record is kept for audit, not deleted.
"""
revokePortalMembership(
"""Membership to revoke."""
id: PortalMembershipID!
): PortalMembershipPayload! @topic(names: ["surfaces"])
"""
Issue a bearer API credential for a membership. The secret is returned only in this response.
"""
createPortalAPICredential(
"""Membership, lifetime and optional restrictions of the credential."""
input: CreatePortalAPICredentialInput!
): CreatePortalAPICredentialPayload! @topic(names: ["surfaces"])
"""
Revoke an API credential so it no longer authenticates. The record is kept for audit, not deleted.
"""
revokePortalAPICredential(
"""Credential to revoke."""
id: PortalAPICredentialID!
): PortalAPICredentialPayload! @topic(names: ["surfaces"])
"""
Issue a single-use login ticket that starts a Portal browser session. The secret is returned only in this response.
"""
createPortalLoginTicket(
"""Target, lifetime and optional restrictions of the ticket."""
input: CreatePortalLoginTicketInput!
): CreatePortalLoginTicketPayload! @topic(names: ["surfaces"])
"""
Revoke an unredeemed login ticket so it can no longer start a session. The record is kept for audit, not deleted.
"""
revokePortalLoginTicket(
"""Ticket to revoke."""
id: PortalLoginTicketID!
): PortalLoginTicketPayload! @topic(names: ["surfaces"])
"""Create a tool definition. Requires mcpTool:write."""
createMCPTool(
"""
Authored fields and assignments. Set published to true for atomic publication.
"""
input: MCPToolInput!
): MCPToolPayload! @topic(names: ["scripting"])
"""Upsert a tool definition. Requires mcpTool:write."""
upsertMCPTool(
"""
Authored fields and assignments. Set published to true for atomic publication.
"""
input: MCPToolInput!
): MCPToolPayload! @topic(names: ["scripting"])
"""Update a tool definition. Requires mcpTool:write."""
updateMCPTool(
"""Tool identity."""
id: MCPToolID!
"""
Authored fields and assignments. Set published to true for atomic publication.
"""
input: MCPToolInput!
): MCPToolPayload! @topic(names: ["scripting"])
"""Analyze and publish the current draft atomically."""
publishMCPTool(
"""Tool identity."""
id: MCPToolID!
"""Exact revision to publish."""
expectedRevision: String!
): MCPToolPayload! @topic(names: ["scripting"])
"""Delete a tool and its versions and assignments."""
deleteMCPTool(
"""Tool identity."""
id: MCPToolID!
): DeletePayload! @topic(names: ["scripting"])
"""
Run an assigned tool as the caller and record the run. Any signed-in user; assignment is the grant. The tool's effects are real and are not rolled back.
"""
invokeMCPTool(
"""Tool to run; must be assigned to the caller, enabled and published."""
toolId: MCPToolID!
"""
Published version the request was prepared against; a newer one refuses the run.
"""
toolVersionId: MCPToolVersionID!
"""Arguments; must match the tool's input schema."""
input: JSON!
"""
1–200 characters chosen by the caller per request; repeating it returns the first invocation without running again.
"""
idempotencyKey: String!
): MCPToolInvocationPayload! @topic(names: ["scripting"])
"""
Run the current draft as the authenticated developer; also requires mcpTool:read.
"""
testMCPTool(
"""Tool draft to run."""
id: MCPToolID!
"""JSON arguments; execution may have real effects."""
inputJSON: String!
): String! @topic(names: ["scripting"])
"""
Declare an integration before any version exists. Requires integration:write permission.
"""
createIntegration(
"""The integration to declare"""
input: CreateIntegrationInput!
): IntegrationPayload! @topic(names: ["integrations"])
"""
Make a version the integration's current version — the default for new installs. Existing instances are never moved. Requires integration:write permission.
"""
publishIntegration(
"""TypeID of the integration (prefix `igr`)"""
id: IntegrationID!
"""
TypeID of the version to make current (prefix `igd`). A DRAFT is validated and promoted to ACTIVE; an ACTIVE version is a rollback or roll-forward; DEPRECATED is refused.
"""
versionId: IntegrationDefinitionID!
): IntegrationPayload! @topic(names: ["integrations"])
"""
Delete an integration that has no versions. Requires integration:delete permission.
"""
deleteIntegration(
"""TypeID of the integration to delete (prefix `igr`)"""
id: IntegrationID!
): DeletePayload! @topic(names: ["integrations"])
"""
Validate a journey definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires journey:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
"""
validateJourneyDefinition(
"""Journey definition JSON document to validate."""
definition: String!
): ValidateSurfacePayload! @topic(names: ["surfaces"])
"""
Validate a workspace definition through the full two-tier pipeline (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL) WITHOUT persisting it. Returns the full diagnostic list. Requires workspace:write. Returns success:false with an explanatory diagnostic when the live schema is unavailable — unlike write mutations, this mutation never silently skips Tier-2.
"""
validateWorkspaceDefinition(
"""Workspace definition JSON document to validate."""
definition: String!
): ValidateSurfacePayload! @topic(names: ["surfaces"])
"""Create a new workflow trigger"""
createWorkflowTrigger(
"""
Workflow, name and type-tagged configuration for the trigger to create.
"""
input: CreateWorkflowTriggerInput!
): WorkflowTriggerPayload! @topic(names: ["workflows"])
"""Update an existing workflow trigger"""
updateWorkflowTrigger(
"""Workflow trigger ID to update"""
id: WorkflowTriggerID!
"""The fields to change; omitted fields are left unchanged."""
input: UpdateWorkflowTriggerInput!
): WorkflowTriggerPayload! @topic(names: ["workflows"])
"""Delete a workflow trigger"""
deleteWorkflowTrigger(
"""
Identifies the trigger to delete. The payload returns the trigger as it looked immediately before deletion.
"""
input: DeleteWorkflowTriggerInput!
): WorkflowTriggerPayload! @topic(names: ["workflows"])
"""Enable a workflow trigger"""
enableWorkflowTrigger(
"""Identifies the trigger to arm; sets isEnabled to true."""
input: EnableWorkflowTriggerInput!
): WorkflowTriggerPayload! @topic(names: ["workflows"])
"""Disable a workflow trigger"""
disableWorkflowTrigger(
"""
Identifies the trigger to disarm; sets isEnabled to false without deleting it.
"""
input: DisableWorkflowTriggerInput!
): WorkflowTriggerPayload! @topic(names: ["workflows"])
"""Start a new workflow execution. Requires workflow:execute permission."""
executeWorkflow(
"""Execution parameters"""
input: ExecuteWorkflowInput!
): ExecuteWorkflowPayload! @topic(names: ["workflows"]) @topic_example(names: ["prepress.run-workflow"])
"""
Cancel a running workflow execution. Requires workflow:execute permission.
"""
cancelExecution(
"""Execution ID to cancel"""
id: WorkflowExecutionID!
): CancelExecutionPayload! @topic(names: ["workflows"])
"""
Resume a workflow execution that is waiting for an external signal. Requires workflow:execute permission.
"""
resumeWorkflowExecution(
"""Execution ID to resume"""
id: WorkflowExecutionID!
): WorkflowExecutionPayload! @topic(names: ["workflows"])
"""
Record authenticated, audited evidence that the exact predecessor process has terminated before workflow recovery. Requires workflow:reconcileRuntime permission.
"""
reconcileWorkflowExecutionRuntime(
"""Execution ID whose predecessor is being reconciled"""
id: WorkflowExecutionID!
"""Observed run-generation fencing token"""
expectedGeneration: String
"""Observed process-incarnation fencing token"""
expectedRunner: String
"""Observed exact runtime claim identity"""
expectedSession: String
"""Observed durable supervisor authority token"""
expectedAuthority: String
"""Observed durable supervisor revision"""
expectedRevision: String
"""Observed legacy execution status, when reconciling a pre-upgrade row"""
expectedStatus: String
"""Observed short-lived row freshness token for a pre-upgrade row"""
expectedRowVersion: String
"""Audited evidence that the exact predecessor process has terminated"""
confirmedTerminationEvidence: String!
): WorkflowExecutionPayload! @topic(names: ["workflows"])
"""
Resolve the best-effort JSON Schema for a node's output given its config — SwiftLua-inferred for script-backed kinds, falling back to the kind's static declared schema. Requires workflow:read permission.
"""
resolveNodeOutputSchema(
"""Node type + config to resolve"""
input: ResolveNodeOutputSchemaInput!
): NodeOutputSchemaPayload! @topic(names: ["workflows"])
"""Create or update a dashboard. Requires dashboard:write permission."""
upsertDashboard(
"""Dashboard data"""
input: UpsertDashboardInput!
): UpsertDashboardPayload! @topic(names: ["apps"])
"""Create a new dashboard. Requires dashboard:write permission."""
createDashboard(
"""Dashboard data"""
input: CreateDashboardInput!
): UpsertDashboardPayload! @topic(names: ["apps"])
"""
Update a dashboard. Only provided fields are changed. Requires dashboard:write permission.
"""
updateDashboard(
"""Dashboard ID to update"""
id: DashboardID!
"""Fields to update — only provided fields are changed"""
input: UpdateDashboardInput!
): UpsertDashboardPayload! @topic(names: ["apps"])
"""
Delete a dashboard and all its cards. Requires dashboard:delete permission.
"""
deleteDashboard(
"""ID of the dashboard to delete"""
id: DashboardID!
): DeletePayload! @topic(names: ["apps"])
"""
Create a card on a dashboard. Only the dashboard owner may. Requires dashboard:write permission.
"""
createDashboardCard(
"""Card data"""
input: CreateDashboardCardInput!
): UpsertDashboardCardPayload! @topic(names: ["apps"])
"""
Update a dashboard card in place. Only the dashboard owner may. Requires dashboard:write permission.
"""
updateDashboardCard(
"""Card ID to update"""
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
"""Fields to update — only provided fields are changed"""
input: UpdateDashboardCardInput!
): UpsertDashboardCardPayload! @topic(names: ["apps"])
"""
Create or update a card within a dashboard. Requires dashboard:write permission.
"""
upsertDashboardCard(
"""Card data"""
input: UpsertDashboardCardInput!
): UpsertDashboardCardPayload! @topic(names: ["apps"])
"""Delete a card from a dashboard. Requires dashboard:write permission."""
deleteDashboardCard(
"""Card ID to delete"""
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
): DeleteDashboardCardPayload! @topic(names: ["apps"])
"""
Bulk update card positions after drag/resize operations. Requires dashboard:write permission.
"""
updateDashboardLayout(
"""Layout update data"""
input: UpdateDashboardLayoutInput!
): UpdateDashboardLayoutPayload! @topic(names: ["apps"])
"""
Export a dashboard and its cards to YAML or JSON. Requires dashboard:read permission.
"""
exportDashboard(
"""Export parameters"""
input: ExportDashboardInput!
): ExportDashboardPayload! @topic(names: ["apps"])
"""
Import a dashboard from YAML or JSON, creating a new dashboard. Requires dashboard:write permission.
"""
importDashboard(
"""Import parameters"""
input: ImportDashboardInput!
): ImportDashboardPayload! @topic(names: ["apps"])
"""Create or update a custom app. Requires customapp:write permission."""
upsertCustomApp(
"""Custom app data"""
input: UpsertCustomAppInput!
): UpsertCustomAppPayload! @topic(names: ["apps"])
"""Create a new custom app. Requires customapp:write permission."""
createCustomApp(
"""Custom app data"""
input: CreateCustomAppInput!
): UpsertCustomAppPayload! @topic(names: ["apps"])
"""
Update a custom app. Only provided fields are changed. Requires customapp:write permission.
"""
updateCustomApp(
"""Custom app ID to update"""
id: CustomAppID!
"""Fields to update — only provided fields are changed"""
input: UpdateCustomAppInput!
): UpsertCustomAppPayload! @topic(names: ["apps"])
"""Delete a custom app. Requires customapp:delete permission."""
deleteCustomApp(
"""ID of the custom app to delete"""
id: CustomAppID!
): DeletePayload! @topic(names: ["apps"])
"""
Create a session token for a custom app. The token should be passed in the X-App-Session header for RPC calls. Open to anyone who can see the app: customapp:read holders by the usual visibility rule, and other signed-in users for a published app assigned to them directly or through a team (as customAppView). Previewing a version needs customapp:read.
"""
createCustomAppSession(
"""Session creation input"""
input: CreateCustomAppSessionInput!
): CustomAppSession! @topic(names: ["apps"])
"""
Publish a specific version of a custom app, making it visible to end users. Requires customapp:write permission.
"""
publishCustomApp(
"""TypeID of the custom app to publish (prefix `cap`)."""
id: CustomAppID!
"""
TypeID of the version to make live (prefix `cav`). Fails with a field error when the version is unknown or belongs to another app. Its content and engine version are copied onto the app — this is what makes it serve.
"""
versionId: CustomAppVersionID!
): UpsertCustomAppPayload! @topic(names: ["apps"])
"""
Upgrade a custom app's engine to v2 after a script-shape lint. Requires customapp:write permission.
"""
setCustomAppEngineVersion(
"""Engine-version upgrade input"""
input: SetCustomAppEngineVersionInput!
): UpsertCustomAppPayload! @topic(names: ["apps"])
"""
Open an in-memory preview of a custom app's draft server API for the caller. Nothing is saved; the preview ends after a period without calls. Source with problems still opens a preview, which holds no server API until fixed. Requires customapp:write.
"""
openCustomAppPreview(
"""The draft to preview."""
input: CustomAppDraftInput!
): OpenCustomAppPreviewPayload! @topic(names: ["apps"])
"""
Push a draft's current server API to its preview. Source with problems is not taken: the last working source keeps running and the problems are returned. Only the person who opened the preview may update it. Requires customapp:write.
"""
updateCustomAppPreview(
"""TypeID of the preview (prefix `dpv`)."""
id: ID!
"""
The draft's current state; appId must be the one the preview was opened with.
"""
input: CustomAppDraftInput!
): UpdateCustomAppPreviewPayload! @topic(names: ["apps"])
"""
End a draft preview now rather than at its idle timeout. Only the person who opened it may close it. Requires customapp:write.
"""
closeDraftPreview(
"""TypeID of the preview (prefix `dpv`)."""
id: ID!
): CloseDraftPreviewPayload! @topic(names: ["apps"])
"""
Attach a user to a custom app. Requires customappuser:write permission.
"""
attachCustomAppUser(
"""Attachment data"""
input: AttachCustomAppUserInput!
): AttachCustomAppUserPayload! @topic(names: ["apps"])
"""
Detach a user from a custom app. Requires customappuser:write permission.
"""
detachCustomAppUser(
"""Detachment data"""
input: DetachCustomAppUserInput!
): DetachCustomAppUserPayload! @topic(names: ["apps"])
"""
Attach a team to a custom app. Requires customappteam:write permission.
"""
attachCustomAppTeam(
"""Attachment data"""
input: AttachCustomAppTeamInput!
): AttachCustomAppTeamPayload! @topic(names: ["apps"])
"""
Detach a team from a custom app. Requires customappteam:write permission.
"""
detachCustomAppTeam(
"""Detachment data"""
input: DetachCustomAppTeamInput!
): DetachCustomAppTeamPayload! @topic(names: ["apps"])
"""
Create a new version snapshot of a custom app. Requires customapp:write permission.
"""
createCustomAppVersion(
"""Version creation input"""
input: CreateCustomAppVersionInput!
): CreateCustomAppVersionPayload! @topic(names: ["apps"])
"""Delete a custom app version. Requires customapp:delete permission."""
deleteCustomAppVersion(
"""ID of the version to delete"""
id: CustomAppVersionID!
): DeletePayload! @topic(names: ["apps"])
"""
Create or update a custom data container. Requires customapp:write permission.
"""
upsertCustomDataContainer(
"""Container data"""
input: UpsertCustomDataContainerInput!
): UpsertCustomDataContainerPayload! @topic(names: ["apps"])
"""Create a custom data container. Requires customapp:write permission."""
createCustomDataContainer(
"""Container data"""
input: CreateCustomDataContainerInput!
): UpsertCustomDataContainerPayload! @topic(names: ["apps"])
"""
Update a custom data container. Only provided fields are changed. Requires customapp:write permission.
"""
updateCustomDataContainer(
"""Container ID to update"""
id: CustomDataContainerID!
"""Fields to update — only provided fields are changed"""
input: UpdateCustomDataContainerInput!
): UpsertCustomDataContainerPayload! @topic(names: ["apps"])
"""Delete a custom data container. Requires customapp:delete permission."""
deleteCustomDataContainer(
"""Delete input"""
input: DeleteCustomDataContainerInput!
): DeletePayload! @topic(names: ["apps"])
"""Create or update a data schema. Requires dataschema:write permission."""
upsertDataSchema(
"""Schema data"""
input: UpsertDataSchemaInput!
): UpsertDataSchemaPayload! @topic(names: ["apps"])
"""Create a new data schema. Requires dataschema:write permission."""
createDataSchema(
"""Schema data"""
input: CreateDataSchemaInput!
): UpsertDataSchemaPayload! @topic(names: ["apps"])
"""
Update a data schema. Only provided fields are changed. Requires dataschema:write permission.
"""
updateDataSchema(
"""Data schema ID to update"""
id: DataSchemaID!
"""Fields to update — only provided fields are changed"""
input: UpdateDataSchemaInput!
): UpsertDataSchemaPayload! @topic(names: ["apps"])
"""Delete a data schema. Requires dataschema:delete permission."""
deleteDataSchema(
"""Delete input"""
input: DeleteDataSchemaInput!
): DeletePayload! @topic(names: ["apps"])
"""Create or update a data record. Requires datarecord:write permission."""
upsertDataRecord(
"""Record data"""
input: UpsertDataRecordInput!
): UpsertDataRecordPayload! @topic(names: ["apps"])
"""Create a new data record. Requires datarecord:write permission."""
createDataRecord(
"""Record data"""
input: CreateDataRecordInput!
): UpsertDataRecordPayload! @topic(names: ["apps"])
"""
Update a data record. Only provided fields are changed. Requires datarecord:write permission.
"""
updateDataRecord(
"""Data record ID to update"""
id: DataRecordID!
"""Fields to update — only provided fields are changed"""
input: UpdateDataRecordInput!
): UpsertDataRecordPayload! @topic(names: ["apps"])
"""Delete a data record. Requires datarecord:delete permission."""
deleteDataRecord(
"""Delete input"""
input: DeleteDataRecordInput!
): DeletePayload! @topic(names: ["apps"])
"""
Create or update a protobuf schema. Requires protobufSchema:write permission.
"""
upsertProtobufSchema(
"""Schema data"""
input: UpsertProtobufSchemaInput!
): UpsertProtobufSchemaPayload! @topic(names: ["apps"])
"""
Create a new protobuf schema. Requires protobufSchema:write permission.
"""
createProtobufSchema(
"""Schema data"""
input: CreateProtobufSchemaInput!
): UpsertProtobufSchemaPayload! @topic(names: ["apps"])
"""
Update a protobuf schema. Only provided fields are changed. Requires protobufSchema:write permission.
"""
updateProtobufSchema(
"""Protobuf schema ID to update"""
id: ProtobufSchemaID!
"""Fields to update — only provided fields are changed"""
input: UpdateProtobufSchemaInput!
): UpsertProtobufSchemaPayload! @topic(names: ["apps"])
"""Delete a protobuf schema. Requires protobufSchema:delete permission."""
deleteProtobufSchema(
"""Delete input"""
input: DeleteProtobufSchemaInput!
): DeletePayload! @topic(names: ["apps"])
"""Create or update a network. Requires network:write permission."""
upsertNetwork(
"""Network data"""
input: UpsertNetworkInput!
): UpsertNetworkPayload! @topic(names: ["devices"])
"""Create a new network. Requires network:write permission."""
createNetwork(
"""Network data"""
input: CreateNetworkInput!
): UpsertNetworkPayload! @topic(names: ["devices"])
"""
Update a network. Only provided fields are changed. Requires network:write permission.
"""
updateNetwork(
"""Network ID to update"""
id: NetworkID!
"""Fields to update — only provided fields are changed"""
input: UpdateNetworkInput!
): UpsertNetworkPayload! @topic(names: ["devices"])
"""Delete a network. Requires network:delete permission."""
deleteNetwork(
"""Network ID to delete"""
id: NetworkID!
): DeletePayload! @topic(names: ["devices"])
"""Create or update a controller. Requires controller:write permission."""
upsertController(
"""Controller data"""
input: UpsertControllerInput!
): UpsertControllerPayload! @topic(names: ["devices"])
"""Create a new controller. Requires controller:write permission."""
createController(
"""Controller data"""
input: CreateControllerInput!
): UpsertControllerPayload! @topic(names: ["devices"])
"""
Update a controller. Only provided fields are changed. Requires controller:write permission.
"""
updateController(
"""Controller ID to update"""
id: ControllerID!
"""Fields to update — only provided fields are changed"""
input: UpdateControllerInput!
): UpsertControllerPayload! @topic(names: ["devices"])
"""Delete a controller. Requires controller:delete permission."""
deleteController(
"""Controller ID to delete"""
id: ControllerID!
): DeletePayload! @topic(names: ["devices"])
"""
Create a new controller token. Returns the signed token value. Requires controller_token:write permission.
"""
createControllerToken(
"""Controller token data"""
input: CreateControllerTokenInput!
): CreateControllerTokenPayload! @topic(names: ["devices"])
"""
Revoke a controller token. Requires controller_token:revoke permission.
"""
revokeControllerToken(
"""Controller token ID to revoke"""
id: ControllerTokenID!
): DeletePayload! @topic(names: ["devices"])
"""Create or update EdgeApp XML and return the authoring view"""
saveEdgeAppSource(
"""XML and observed draft source for an update"""
input: UpsertEdgeAppSourceInput!
): EdgeAppSourcePayload! @topic(names: ["devices"])
"""
Publish only the reviewed EdgeApp XML; repeated immutable source is a no-op
"""
publishEdgeAppSource(
"""Draft to publish"""
id: EdgeAppID!
"""Exact reviewed source to freeze"""
sourceXML: String!
): EdgeAppSourcePayload! @topic(names: ["devices"])
"""
Create or update a DRAFT edge app row. With `input.id`: edits the existing draft (rejects PUBLISHED/DEPRECATED rows — those are frozen). Without `input.id`: creates a new draft for the handle (rejects if a draft already exists). Drafts aren't pushed to controllers; use publishEdgeAppDraft to ship. Requires edge_app:write permission.
"""
upsertEdgeApp(
"""EdgeApp definition"""
input: UpsertEdgeAppInput!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Compile, validate, and retain an EdgeApp XML document as a DRAFT. Omit id to create; provide a DRAFT id to replace its source.
"""
upsertEdgeAppSource(
"""Authoritative EdgeApp XML source"""
input: UpsertEdgeAppSourceInput!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Create a new DRAFT edge app row for `input.handle`. Rejects if a draft already exists for the handle (finish or delete it first). Drafts aren't pushed to controllers; use publishEdgeAppDraft to ship. Requires edge_app:write permission.
"""
createEdgeApp(
"""EdgeApp definition"""
input: CreateEdgeAppInput!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Update an existing DRAFT edge app row. Rejects PUBLISHED/DEPRECATED rows (frozen) and attempts to change `handle` (immutable on an existing draft). Only provided fields are changed. Requires edge_app:write permission.
"""
updateEdgeApp(
"""Draft edge app ID to update"""
id: EdgeAppID!
"""Fields to update — only provided fields are changed"""
input: UpdateEdgeAppInput!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Freeze a DRAFT and flip it to PUBLISHED. Auto-deprecates the previously-PUBLISHED row for the same handle. Pushes config.update to every controller running an installation that pinned the newly-published row. Requires edge_app:write.
"""
publishEdgeAppDraft(
"""Draft edge app ID to publish"""
id: EdgeAppID!
"""
Optional exact reviewed source precondition; publication fails if the current draft no longer matches it.
"""
expectedSourceXML: String
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Mark a PUBLISHED row as DEPRECATED. Used to retire an app without a replacement. Existing installations stay pinned and keep working until upgraded or uninstalled. Idempotent on already-DEPRECATED rows; rejects DRAFT rows (delete them instead). Requires edge_app:write permission.
"""
deprecateEdgeApp(
"""PUBLISHED edge app ID to deprecate"""
id: EdgeAppID!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Delete a edge app row. Cascades to all installations pinning this row and pushes config.update to each affected controller. Use deprecateEdgeApp instead to retire a PUBLISHED row without losing installation history.
"""
deleteEdgeApp(
"""Edge app ID to delete"""
id: EdgeAppID!
): DeletePayload! @topic(names: ["devices"])
"""
Invoke a edgeApp's onMessage export by name on a specific controller (the edgeApp must be installed on it). Forwards to the bridge and returns the function's JSON return value. Requires edge_app:invoke permission.
"""
invokeEdgeApp(
"""EdgeApp invocation request"""
input: InvokeEdgeAppInput!
): InvokeEdgeAppPayload! @topic(names: ["devices"])
"""Export an edge app to YAML or JSON. Requires edge_app:read permission."""
exportEdgeApp(
"""Export parameters"""
input: ExportEdgeAppInput!
): ExportEdgeAppPayload! @topic(names: ["devices"])
"""
Import an edge app from YAML or JSON, landing it as a DRAFT (replaces an existing DRAFT for the handle, or allocates the next version). Requires edge_app:write permission.
"""
importEdgeApp(
"""Import parameters"""
input: ImportEdgeAppInput!
): UpsertEdgeAppPayload! @topic(names: ["devices"])
"""
Type-check Lua source against the ambient typedef for the chosen role without persisting anything. Safe to call from editors on every keystroke.
"""
validateLua(
"""Lua source + role + options"""
input: ValidateLuaInput!
): ValidateLuaResult! @topic(names: ["scripting"])
"""
Statically validate a workflow expression (parse + filter-name check) without evaluating it. Safe to call from editors on every keystroke.
"""
validateJinja(
"""Workflow expression source + format"""
input: ValidateJinjaInput!
): ValidateJinjaResult! @topic(names: ["workflows"])
"""
Create or update a edgeApp installation. Validates `variables` against the edgeApp's configSchema (when set) and pushes config.update to the target controller. Requires edge_app_installation:write permission.
"""
upsertEdgeAppInstallation(
"""Installation definition"""
input: UpsertEdgeAppInstallationInput!
): UpsertEdgeAppInstallationPayload! @topic(names: ["devices"])
"""
Create a edgeApp installation. Validates the edgeApp exists in this tenant and isn't DRAFT, that the controller exists, that an optional bot user exists, and `variables` against the edgeApp's configSchema (when set); pushes config.update to the target controller. Requires edge_app_installation:write permission.
"""
createEdgeAppInstallation(
"""Installation definition"""
input: CreateEdgeAppInstallationInput!
): UpsertEdgeAppInstallationPayload! @topic(names: ["devices"])
"""
Update a edgeApp installation. Only provided fields are changed; `edgeAppId` is immutable (delete and recreate to change it). Re-validates the controller and bot user (if changed) and `variables` against the edgeApp's configSchema. Pushes config.update to the controller. Requires edge_app_installation:write permission.
"""
updateEdgeAppInstallation(
"""EdgeApp installation ID to update"""
id: EdgeAppInstallationID!
"""Fields to update — only provided fields are changed"""
input: UpdateEdgeAppInstallationInput!
): UpsertEdgeAppInstallationPayload! @topic(names: ["devices"])
"""
Repoint an installation at a different version of the same edgeApp. Validates the target row exists, belongs to this tenant, shares the installation's current handle, and isn't a DRAFT (only PUBLISHED or DEPRECATED versions can be pinned). Pushes config.update to the controller. The bridge reconciles by `installation.id`+`version`, so the new version triggers a restart with the new content. Requires edge_app_installation:write.
"""
upgradeEdgeAppInstallation(
"""Edge app installation ID to upgrade"""
id: EdgeAppInstallationID!
"""Upgrade input"""
input: UpgradeEdgeAppInstallationInput!
): UpsertEdgeAppInstallationPayload! @topic(names: ["devices"])
"""
Delete a edgeApp installation. Triggers a config.update push to the controller.
"""
deleteEdgeAppInstallation(
"""EdgeApp installation ID to delete"""
id: EdgeAppInstallationID!
): DeletePayload! @topic(names: ["devices"])
"""
Create or update the policy for a controller. Idempotent on controllerId (one row per controller). Wholesale-replace on both allowlists. Triggers a config.update push to the controller. Requires controller_policy:write permission.
"""
upsertControllerPolicy(
"""Policy contents"""
input: UpsertControllerPolicyInput!
): UpsertControllerPolicyPayload! @topic(names: ["devices"])
"""
Create a new controller policy. The referenced controller must exist in this tenant. Triggers a config.update push to the controller. Requires controller_policy:write permission.
"""
createControllerPolicy(
"""Policy contents"""
input: CreateControllerPolicyInput!
): UpsertControllerPolicyPayload! @topic(names: ["devices"])
"""
Update a controller policy. Only provided fields are changed. The referenced controller must exist in this tenant. Triggers a config.update push to the controller. Requires controller_policy:write permission.
"""
updateControllerPolicy(
"""Controller policy ID to update"""
id: ControllerPolicyID!
"""Fields to update — only provided fields are changed"""
input: UpdateControllerPolicyInput!
): UpsertControllerPolicyPayload! @topic(names: ["devices"])
"""
Delete a controller's policy. The controller falls back to default-deny on the next config.update push. Requires controller_policy:delete permission.
"""
deleteControllerPolicy(
"""Controller policy ID to delete"""
id: ControllerPolicyID!
): DeletePayload! @topic(names: ["devices"])
"""Create or update a device. Requires device:write permission."""
upsertDevice(
"""Device data"""
input: UpsertDeviceInput!
): UpsertDevicePayload! @topic(names: ["devices"])
"""Create a new device. Requires device:write permission."""
createDevice(
"""Device data"""
input: CreateDeviceInput!
): UpsertDevicePayload! @topic(names: ["devices"])
"""
Update a device. Only provided fields are changed. Requires device:write permission.
"""
updateDevice(
"""Device ID to update"""
id: DeviceID!
"""Fields to update — only provided fields are changed"""
input: UpdateDeviceInput!
): UpsertDevicePayload! @topic(names: ["devices"])
"""Delete a device. Requires device:delete permission."""
deleteDevice(
"""Device ID to delete"""
id: DeviceID!
): DeletePayload! @topic(names: ["devices"])
"""
Create a new device token. Returns the signed token value. Requires device_token:write permission.
"""
createDeviceToken(
"""Device token data"""
input: CreateDeviceTokenInput!
): CreateDeviceTokenPayload! @topic(names: ["devices"])
"""Revoke a device token. Requires device_token:revoke permission."""
revokeDeviceToken(
"""Device token ID to revoke"""
id: DeviceTokenID!
): DeletePayload! @topic(names: ["devices"])
"""
Create a new API token for the calling user. Returns the token string only once. Requires apitoken:write permission.
"""
createAPIToken(
"""Token data"""
input: CreateAPITokenInput!
): CreateAPITokenPayload! @topic(names: ["admin"])
"""
Create a new API token on behalf of a bot user. Fails if the target user is not a bot. Requires apitoken:write permission.
"""
createBotAPIToken(
"""Bot token data, including the target bot user ID"""
input: CreateBotAPITokenInput!
): CreateAPITokenPayload! @topic(names: ["admin"])
"""Revoke an API token. Requires apitoken:revoke permission."""
revokeAPIToken(
"""API token ID to revoke"""
id: APITokenID!
): RevokeAPITokenPayload! @topic(names: ["admin"])
"""
Revoke an API token belonging to a bot user. Fails if the token's owner is not a bot. Requires apitoken:revoke permission.
"""
revokeBotAPIToken(
"""API token ID to revoke"""
id: APITokenID!
): RevokeAPITokenPayload! @topic(names: ["admin"])
"""Create or update an AI adapter. Requires aiadapter:write permission."""
upsertAIAdapter(
"""AI adapter data"""
input: UpsertAIAdapterInput!
): UpsertAIAdapterPayload! @topic(names: ["aiml"])
"""Create a new AI adapter. Requires aiadapter:write permission."""
createAIAdapter(
"""AI adapter data"""
input: CreateAIAdapterInput!
): UpsertAIAdapterPayload! @topic(names: ["aiml"])
"""
Update an AI adapter. Only provided fields are changed. Requires aiadapter:write permission.
"""
updateAIAdapter(
"""AI adapter ID to update"""
id: AIAdapterID!
"""Fields to update — only provided fields are changed"""
input: UpdateAIAdapterInput!
): UpsertAIAdapterPayload! @topic(names: ["aiml"])
"""Delete an AI adapter. Requires aiadapter:delete permission."""
deleteAIAdapter(
"""ID of the AI adapter to delete"""
id: AIAdapterID!
): DeletePayload! @topic(names: ["aiml"])
"""
Verify provider credentials and all effective configured models using provider model endpoints. Does not generate content. Requires aiadapter:read permission.
"""
testAIAdapter(
"""ID of the AI adapter to test"""
id: AIAdapterID!
): TestAIAdapterPayload! @topic(names: ["aiml"])
"""Create or update an AI agent. Requires aiAgent:write permission."""
upsertAIAgent(
"""AI agent data"""
input: UpsertAIAgentInput!
): UpsertAIAgentPayload! @topic(names: ["aiml"])
"""Create a new AI agent. Requires aiAgent:write permission."""
createAIAgent(
"""AI agent data"""
input: CreateAIAgentInput!
): UpsertAIAgentPayload! @topic(names: ["aiml"])
"""
Update an AI agent. Only provided fields are changed. Requires aiAgent:write permission.
"""
updateAIAgent(
"""AI agent ID to update"""
id: AIAgentID!
"""Fields to update — only provided fields are changed"""
input: UpdateAIAgentInput!
): UpsertAIAgentPayload! @topic(names: ["aiml"])
"""Delete an AI agent. Requires aiAgent:delete permission."""
deleteAIAgent(
"""AI agent ID to delete"""
id: AIAgentID!
): DeletePayload! @topic(names: ["aiml"])
"""
Create or replace ML XML authoring source. Updates require the observed authoring revision and preserve training and publication state.
"""
upsertMLModelSource(
"""
Authoritative ML XML and, for updates, the model identity and observed authoring revision.
"""
input: MLModelSourceInput!
): UpsertMLModelConfigPayload! @topic(names: ["aiml"])
"""
Create or update an ML model config. Requires mlmodelconfig:write permission.
"""
upsertMLModelConfig(
"""ML model config data"""
input: UpsertMLModelConfigInput!
): UpsertMLModelConfigPayload! @topic(names: ["aiml"])
"""Create a new ML model config. Requires mlmodelconfig:write permission."""
createMLModelConfig(
"""ML model config data"""
input: CreateMLModelConfigInput!
): UpsertMLModelConfigPayload! @topic(names: ["aiml"])
"""
Update an ML model config. Only provided fields are changed. Requires mlmodelconfig:write permission.
"""
updateMLModelConfig(
"""ML model config ID to update"""
id: MLModelConfigID!
"""Fields to update — only provided fields are changed"""
input: UpdateMLModelConfigInput!
): UpsertMLModelConfigPayload! @topic(names: ["aiml"])
"""Delete an ML model config. Requires mlmodelconfig:delete permission."""
deleteMLModelConfig(
"""ID of the ML model config to delete"""
id: MLModelConfigID!
): DeletePayload! @topic(names: ["aiml"])
"""
Trigger training for an ML model. Requires mlmodelconfig:execute permission.
"""
trainMLModel(
"""ID of the ML model config to train"""
id: MLModelConfigID!
): TrainMLModelPayload! @topic(names: ["aiml"])
"""
Run the data pipeline over a sample WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission.
"""
previewMLModelPipeline(
"""ID of the ML model config whose pipeline to preview"""
id: MLModelConfigID!
"""
Optional stage list to preview instead of the saved stages (live editing)
"""
stagesOverride: [MLNormalizationStageInput!]
"""
Max emitted rows to inspect and return in sampleRows (default 1000). totalRows is the number sampled, not a full source count. Zero returns schema only; negative values are invalid. Training still reads the full source.
"""
sampleLimit: Int
): DataScriptPreview! @topic(names: ["aiml"])
"""
Import an ML model config from JSON or YAML. Requires mlmodelconfig:write permission.
"""
importMLModelConfig(
"""Import input (content, format, optional name override)"""
input: ImportMLModelConfigInput!
): ImportMLModelConfigPayload! @topic(names: ["aiml"])
"""
Run a prediction using a trained ML model. Requires mlmodelconfig:execute permission.
"""
predictMLModel(
"""ID of the ML model config to use for prediction"""
id: MLModelConfigID!
"""Feature values as JSON string"""
input: String!
): PredictMLModelPayload! @topic(names: ["aiml"])
"""
Forecast future values using a trained time-series model. Requires mlmodelconfig:execute permission.
"""
forecastMLModel(
"""ID of the trained time-series model config to forecast with"""
id: MLModelConfigID!
"""Number of steps ahead to forecast"""
horizon: Int!
"""Optional confidence level (0–1) for prediction intervals"""
level: Float
): ForecastMLModelPayload! @topic(names: ["aiml"])
"""
Manually trigger retraining of all system-managed ML models for the current tenant. Requires mlmodelconfig:execute permission.
"""
retrainSystemModels: RetrainSystemModelsPayload! @topic(names: ["aiml"])
"""
Set a version as the published version used for predictions. Requires mlmodelconfig:write permission.
"""
publishMLModelVersion(
"""ML model config ID"""
configId: MLModelConfigID!
"""Version ID to publish"""
versionId: MLModelConfigVersionID!
): PublishMLModelVersionPayload! @topic(names: ["aiml"])
"""
Start a personal ML experiment, blank or from an existing model's XML. Requires mlmodelconfig:execute permission and a signed-in user.
"""
createMLExperiment(
"""The new experiment"""
input: CreateMLExperimentInput!
): MLExperimentPayload! @topic(names: ["aiml"])
"""
Rename one of your ML experiments or change its draft XML. Requires mlmodelconfig:execute permission and a signed-in user.
"""
updateMLExperiment(
"""ID of one of your experiments"""
id: MLExperimentID!
"""The changes; omitted fields are unchanged"""
input: UpdateMLExperimentInput!
): MLExperimentPayload! @topic(names: ["aiml"])
"""
Delete one of your ML experiments with its runs and their models. Requires mlmodelconfig:execute permission and a signed-in user.
"""
deleteMLExperiment(
"""ID of one of your experiments"""
id: MLExperimentID!
): DeletePayload! @topic(names: ["aiml"])
"""
Train an experiment's current XML on its CSV as a new numbered run. One run trains at a time per experiment, and at most two per workspace. Older unpinned runs beyond the workspace's keepUnpinnedRuns setting expire. Requires mlmodelconfig:execute permission and a signed-in user.
"""
trainMLExperiment(
"""ID of one of your experiments"""
id: MLExperimentID!
): MLExperimentRunPayload! @topic(names: ["aiml"])
"""
Try one of your experiment runs: predict with its model. Expired and forecast runs are refused. Requires mlmodelconfig:execute permission and a signed-in user.
"""
predictMLExperimentRun(
"""ID of one of your trained experiment runs"""
runId: MLExperimentRunID!
"""Feature values as a JSON object string"""
input: String!
): PredictMLModelPayload! @topic(names: ["aiml"])
"""
Try one of your forecast experiment runs: forecast the series it trained on. Expired runs and runs that are not forecasts are refused. Requires mlmodelconfig:execute permission and a signed-in user.
"""
forecastMLExperimentRun(
"""ID of one of your trained forecast runs"""
runId: MLExperimentRunID!
"""
Number of steps past the end of the series to forecast; zero or less uses the run's own horizon
"""
horizon: Int!
"""
Confidence level (0–1) of the forecast's interval; omitted uses the run's own level
"""
level: Float
): ForecastMLModelPayload! @topic(names: ["aiml"])
"""
Pin or unpin one of your experiment runs. A pinned run never expires. Pinning is refused once the experiment has the workspace's maxPinnedRuns pinned runs ("Unpin a run first"), or when that setting is 0 ("Pinning is turned off in Settings"); unpinning never is. Requires mlmodelconfig:execute permission and a signed-in user.
"""
pinMLExperimentRun(
"""ID of one of your trained experiment runs"""
runId: MLExperimentRunID!
"""True to pin the run, false to unpin it"""
pinned: Boolean!
): MLExperimentRunPayload! @topic(names: ["aiml"])
"""
Run an experiment's data pipeline over a sample of its CSV WITHOUT training and return the emitted fields. Requires mlmodelconfig:execute permission and a signed-in user.
"""
previewMLExperimentPipeline(
"""ID of one of your experiments"""
id: MLExperimentID!
"""
Optional stage list to preview instead of the stages in the experiment's XML (live editing)
"""
stagesOverride: [MLNormalizationStageInput!]
"""
Max emitted rows to inspect and return in sampleRows (default 1000). Zero returns schema only; negative values are invalid.
"""
sampleLimit: Int
): DataScriptPreview! @topic(names: ["aiml"])
"""
Create a new chat session. An OPS session needs only a login; any other context requires chatsession:write permission.
"""
createChatSession(
"""Chat session data"""
input: CreateChatSessionInput!
): ChatSessionPayload! @topic(names: ["aiml"])
"""
Update an existing chat session. Requires chatsession:write permission.
"""
updateChatSession(
"""Chat session ID to update"""
id: ChatSessionID!
"""Chat session update data"""
input: UpdateChatSessionInput!
): ChatSessionPayload! @topic(names: ["aiml"])
"""Delete a chat session. Requires chatsession:delete permission."""
deleteChatSession(
"""ID of the chat session to delete"""
id: ChatSessionID!
): DeletePayload! @topic(names: ["aiml"])
"""
Send a message to a chat session and receive an AI response. Requires chatsession:write permission.
"""
sendChatMessage(
"""Message to send"""
input: SendChatMessageInput!
): ChatMessageResponse! @topic(names: ["aiml"])
"""
Clear all messages from a chat session. Requires chatsession:write permission.
"""
clearChatMessages(
"""Session to clear messages from"""
sessionId: ChatSessionID!
): ChatSessionPayload! @topic(names: ["aiml"])
"""
Create a new integration definition. Requires integrationDefinition:write permission.
"""
createIntegrationDefinition(
"""Integration definition creation input"""
input: CreateIntegrationDefinitionInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Delete an integration definition. The final unused version may be deleted, clearing the current version with integration:write permission. Refuses while any instance is installed from it, rather than cascading — an instance reads its definition's manifest at execution time, so removing one underneath a live integration breaks it at the next fire rather than here. Requires integrationDefinition:delete permission.
"""
deleteIntegrationDefinition(
"""TypeID (prefix `igd`) of the definition to delete."""
id: IntegrationDefinitionID!
): DeletePayload! @topic(names: ["integrations"])
"""
Deprecate an integration definition. Requires integrationDefinition:write permission.
"""
deprecateIntegrationDefinition(
"""Integration definition deprecation input"""
input: DeprecateIntegrationDefinitionInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Create a new integration draft. Requires integrationDefinition:write permission.
"""
createIntegrationDraft(
"""Draft creation input"""
input: CreateIntegrationDraftInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Update a single file in a draft's bundle. Requires integrationDefinition:write permission.
"""
updateIntegrationDraftFile(
"""Integration draft ID to update"""
id: IntegrationDefinitionID!
"""File update input"""
input: UpdateIntegrationDraftFileInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Update manifest fields on a draft. Requires integrationDefinition:write permission.
"""
updateIntegrationDraftManifest(
"""Integration draft ID to update"""
id: IntegrationDefinitionID!
"""Manifest update input"""
input: UpdateIntegrationDraftManifestInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Validate a draft without publishing. Requires integrationDefinition:write permission.
"""
validateIntegrationDraft(
"""Validation input"""
input: ValidateIntegrationDraftInput!
): IntegrationValidationResult! @topic(names: ["integrations"])
"""
Validate and publish a draft as an active definition. Requires integrationDefinition:write permission.
"""
publishIntegrationDraft(
"""Publish input"""
input: PublishIntegrationDraftInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Export an integration definition to YAML or JSON. Requires integrationDefinition:read permission.
"""
exportIntegrationDefinition(
"""Export parameters"""
input: ExportIntegrationDefinitionInput!
): ExportIntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Import an integration definition from YAML or JSON, creating a new DRAFT. Requires integrationDefinition:write permission.
"""
importIntegrationDefinition(
"""Import parameters"""
input: ImportIntegrationDefinitionInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Compile XML with the native platform validator without persisting anything. Returns field paths and source ranges. Requires integrationDefinition:read.
"""
validateIntegrationDefinitionSource(
"""
Integration XML to compile without creating or changing persisted definitions.
"""
input: IntegrationDefinitionSourceInput!
): IntegrationDefinitionSourceValidation! @topic(names: ["integrations"])
"""
Create a native XML definition in DRAFT status under its integration parent. Creates no installation, bindings or secrets. Requires integrationDefinition:write.
"""
createIntegrationDefinitionSource(
"""
Exact Integration XML for a new native draft under its declared integration parent.
"""
input: IntegrationDefinitionSourceInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Replace a native draft XML document using expectedRevision. Root id/version and published versions are immutable. Requires integrationDefinition:write.
"""
updateIntegrationDefinitionSource(
"""Draft identity, observed revision and replacement authoritative XML."""
input: UpdateIntegrationDefinitionSourceInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Import exact XML as a new native DRAFT version. Existing versions are never overwritten and installation values are not imported. Requires integrationDefinition:write.
"""
importIntegrationDefinitionSource(
"""
Exact Integration XML to import as a new draft without overwriting existing versions.
"""
input: IntegrationDefinitionSourceInput!
): IntegrationDefinitionPayload! @topic(names: ["integrations"])
"""
Export the exact authoritative Integration XML, preserving comments, whitespace and CDATA. Requires integrationDefinition:read.
"""
exportIntegrationDefinitionSource(
"""
Definition version whose authoritative native Integration XML should be exported.
"""
id: IntegrationDefinitionID!
): IntegrationDefinitionSourceExport! @topic(names: ["integrations"])
"""
Explicit operator attestation after confirming exact predecessor termination and reconciling all external effects. Fences the retired session and retains evidence; never replays or marks a hook successful. Requires integrationInstance:write.
"""
reconcileRetiredIntegrationRuntime(
"""Deleted integration installation whose retired session to reconcile."""
id: IntegrationInstanceID!
"""Exact retired session from integrationRuntimeRetirements."""
expectedSession: IntegrationRuntimeSessionID!
"""
Exact authority/predecessor from that retirement's management state; null only when it is null.
"""
expectedAuthority: IntegrationSchedulerAuthorityID
"""Decimal management revision from that retirement's management state."""
expectedRevision: String!
"""
Required evidence identifying the terminated predecessor process and reconciliation of its external effects; never infer termination from timeout or lease expiry.
"""
confirmedTerminationEvidence: String!
): IntegrationRuntimeRetirementPayload! @topic(names: ["integrations"])
"""
Operator attestation: use ONLY after confirming the exact predecessor process has terminated and reconciling all its external effects. Records evidence, fences and pauses the installation; preserves attempt budgets. Requires integrationInstance:write.
"""
reconcileIntegrationRuntime(
"""Integration installation to manage."""
id: IntegrationInstanceID!
"""Exact native session from integrationRuntimeManagement."""
expectedSession: IntegrationRuntimeSessionID!
"""
Exact authority/predecessor from integrationRuntimeManagement; null only when that query returns null.
"""
expectedAuthority: IntegrationSchedulerAuthorityID
"""Decimal management revision returned by the query."""
expectedRevision: String!
"""
Required evidence identifying the terminated predecessor process and reconciliation of its external effects; never infer termination from timeout or lease expiry.
"""
confirmedTerminationEvidence: String!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Reset one paused, confirmed-stopped scheduler child's durable attempt budget, with an audited reason and expected management revision. Requires integrationInstance:write.
"""
resetIntegrationRuntimeChild(
"""Integration installation to manage."""
id: IntegrationInstanceID!
"""Exact native session from integrationRuntimeManagement."""
expectedSession: IntegrationRuntimeSessionID!
"""Decimal management revision returned by the query."""
expectedRevision: String!
"""Exact stable child key returned by integrationRuntimeManagement."""
child: String!
"""Required operator reason for resetting this stopped child budget."""
reason: String!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Create a new integration instance. Requires integrationInstance:write permission.
"""
createIntegrationInstance(
"""Integration instance creation input"""
input: CreateIntegrationInstanceInput!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Set one secret on an integration instance. Secrets are not settable through `config` — this is the only way in. Requires integrationInstance:write permission.
"""
setIntegrationInstanceSecret(
"""TypeID of the integration instance."""
id: IntegrationInstanceID!
"""
Config key to set. Must be declared a secret by the definition's schema (`x-input-type: password`); see the instance's `secrets`.
"""
key: String!
"""The secret. Stored encrypted and never returned by any query."""
value: String!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Remove a stored secret from an integration instance. Requires integrationInstance:write permission.
"""
clearIntegrationInstanceSecret(
"""TypeID of the integration instance."""
id: IntegrationInstanceID!
"""Secret key to remove."""
key: String!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Update an integration instance. Requires integrationInstance:write permission.
"""
updateIntegrationInstance(
"""Integration instance ID to update"""
id: IntegrationInstanceID!
"""Integration instance update input"""
input: UpdateIntegrationInstanceInput!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Move an integration instance to a newer version of the same integration. Runs the new definition's upgrade hook between stop and start. Requires integrationInstance:write permission.
"""
upgradeIntegrationInstance(
"""Integration instance ID to upgrade"""
id: IntegrationInstanceID!
"""Integration instance upgrade input"""
input: UpgradeIntegrationInstanceInput!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Start an integration instance. Requires integrationInstance:write permission.
"""
startIntegrationInstance(
"""Integration instance ID to start"""
id: IntegrationInstanceID!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Pause an integration instance. Requires integrationInstance:write permission.
"""
pauseIntegrationInstance(
"""Integration instance ID to pause"""
id: IntegrationInstanceID!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Run a named Action a running integration instance declares, and return its handler's JSON result. Discover Actions and their input schemas on the definition's manifest. Requires integrationInstance:write permission.
"""
runIntegrationAction(
"""Run-Action input"""
input: RunIntegrationActionInput!
): IntegrationActionResult! @topic(names: ["integrations"])
"""
Manually fire a named timer on a running integration instance. Requires integrationInstance:write permission.
"""
runIntegrationTimer(
"""Run-timer input"""
input: RunIntegrationTimerInput!
): IntegrationInstancePayload! @topic(names: ["integrations"])
"""
Delete an integration instance. Requires integrationInstance:delete permission.
"""
deleteIntegrationInstance(
"""Integration instance ID to delete"""
id: IntegrationInstanceID!
"""
Skip uninstall and permanently delete instance data after runtime shutdown. Remote resources may require manual cleanup.
"""
force: Boolean
): DeletePayload! @topic(names: ["integrations"])
"""
Create a session token for an integration instance. Requires integrationInstance:read permission.
"""
createIntegrationSession(
"""Integration session creation input"""
input: CreateIntegrationSessionInput!
): IntegrationSessionOutput! @topic(names: ["integrations"])
"""
Create or update an integration data container. Requires integrationDataContainer:write permission.
"""
upsertIntegrationDataContainer(
"""Container data"""
input: UpsertIntegrationDataContainerInput!
): UpsertIntegrationDataContainerPayload! @topic(names: ["integrations"])
"""
Create a new integration data container. Requires integrationDataContainer:write permission.
"""
createIntegrationDataContainer(
"""Container data"""
input: CreateIntegrationDataContainerInput!
): UpsertIntegrationDataContainerPayload! @topic(names: ["integrations"])
"""
Update an integration data container. Only provided fields are changed. Requires integrationDataContainer:write permission.
"""
updateIntegrationDataContainer(
"""Container ID to update"""
id: IntegrationDataContainerID!
"""Fields to update — only provided fields are changed"""
input: UpdateIntegrationDataContainerInput!
): UpsertIntegrationDataContainerPayload! @topic(names: ["integrations"])
"""
Delete an integration data container. Requires integrationDataContainer:delete permission.
"""
deleteIntegrationDataContainer(
"""Delete input"""
input: DeleteIntegrationDataContainerInput!
): DeletePayload! @topic(names: ["integrations"])
"""
Create a custom action, or overwrite an existing one when input.id is supplied. Overwrite semantics: omitted optional fields are written as null, unlike updateCustomWorkflowAction. Requires customWorkflowAction:write permission.
"""
upsertCustomWorkflowAction(
"""
The action to write. With an id, the existing action is overwritten in place; without one, a new action is created.
"""
input: UpsertCustomWorkflowActionInput!
): UpsertCustomWorkflowActionPayload! @topic(names: ["scripting"])
"""
Create a new custom action. Requires customWorkflowAction:write permission.
"""
createCustomWorkflowAction(
"""Definition of the custom action to create."""
input: CreateCustomWorkflowActionInput!
): UpsertCustomWorkflowActionPayload! @topic(names: ["scripting"])
"""
Update a custom action. Only provided fields are changed. Requires customWorkflowAction:write permission.
"""
updateCustomWorkflowAction(
"""TypeID (prefix `cac`) of the custom action to update."""
id: CustomWorkflowActionID!
"""The fields to change; omitted fields are left as they are."""
input: UpdateCustomWorkflowActionInput!
): UpsertCustomWorkflowActionPayload! @topic(names: ["scripting"])
"""
Permanently delete a custom action from the caller's tenant. Reports notFound when no such action exists. Requires customWorkflowAction:delete permission.
"""
deleteCustomWorkflowAction(
"""TypeID (prefix `cac`) of the custom action to delete."""
id: CustomWorkflowActionID!
): DeletePayload! @topic(names: ["scripting"])
"""
Create a new notification group. Requires notificationGroup:write permission.
"""
createNotificationGroup(
"""Notification group data"""
input: CreateNotificationGroupInput!
): UpsertNotificationGroupPayload! @topic(names: ["integrations"])
"""
Update a notification group. Requires notificationGroup:write permission.
"""
updateNotificationGroup(
"""Notification group ID to update"""
id: NotificationGroupID!
"""Updated notification group data"""
input: UpdateNotificationGroupInput!
): UpsertNotificationGroupPayload! @topic(names: ["integrations"])
"""
Delete a notification group. Requires notificationGroup:delete permission.
"""
deleteNotificationGroup(
"""Notification group ID to delete"""
id: NotificationGroupID!
): DeletePayload! @topic(names: ["integrations"])
"""
Create a new notification recipient. Requires notificationRecipient:write permission.
"""
createNotificationRecipient(
"""Notification recipient data"""
input: CreateNotificationRecipientInput!
): UpsertNotificationRecipientPayload! @topic(names: ["integrations"])
"""
Update a notification recipient. Requires notificationRecipient:write permission.
"""
updateNotificationRecipient(
"""Notification recipient ID to update"""
id: NotificationRecipientID!
"""Updated recipient data"""
input: UpdateNotificationRecipientInput!
): UpsertNotificationRecipientPayload! @topic(names: ["integrations"])
"""
Delete a notification recipient. Requires notificationRecipient:delete permission.
"""
deleteNotificationRecipient(
"""Notification recipient ID to delete"""
id: NotificationRecipientID!
): DeletePayload! @topic(names: ["integrations"])
"""
Create or update an incoming webhook. Requires incomingWebhook:write permission.
"""
upsertIncomingWebhook(
"""Webhook data"""
input: UpsertIncomingWebhookInput!
): UpsertIncomingWebhookPayload! @topic(names: ["integrations"])
"""
Create a new incoming webhook. Requires incomingWebhook:write permission.
"""
createIncomingWebhook(
"""Webhook data"""
input: CreateIncomingWebhookInput!
): UpsertIncomingWebhookPayload! @topic(names: ["integrations"])
"""
Update an incoming webhook. Only provided fields are changed. Requires incomingWebhook:write permission.
"""
updateIncomingWebhook(
"""Webhook ID to update"""
id: IncomingWebhookID!
"""Fields to update — only provided fields are changed"""
input: UpdateIncomingWebhookInput!
): UpsertIncomingWebhookPayload! @topic(names: ["integrations"])
"""
Delete an incoming webhook. Requires incomingWebhook:delete permission.
"""
deleteIncomingWebhook(
"""Webhook ID to delete"""
id: IncomingWebhookID!
): DeletePayload! @topic(names: ["integrations"])
"""Create or update a metric. Requires metric:write permission."""
upsertMetric(
"""Metric data"""
input: UpsertMetricInput!
): UpsertMetricPayload! @topic(names: ["devices"])
"""Create a new metric. Requires metric:write permission."""
createMetric(
"""Metric data"""
input: CreateMetricInput!
): UpsertMetricPayload! @topic(names: ["devices"])
"""
Update a metric. Only provided fields are changed. Requires metric:write permission.
"""
updateMetric(
"""Metric ID to update"""
id: MetricID!
"""Fields to update — only provided fields are changed"""
input: UpdateMetricInput!
): UpsertMetricPayload! @topic(names: ["devices"])
"""
Record one or more data points for a metric. Requires metric:write permission.
"""
recordMetricPoints(
"""Points to record"""
input: RecordMetricPointsInput!
): RecordMetricPointsPayload! @topic(names: ["devices"])
"""
Delete a metric and all its data points. Requires metric:delete permission.
"""
deleteMetric(
"""Metric ID to delete"""
id: MetricID!
): DeletePayload! @topic(names: ["devices"])
"""
Record one or more progress tracking data points. Up to 10,000 points per request. Requires progressPoint:write permission.
"""
recordProgressPoints(
"""Points to record"""
input: RecordProgressPointsInput!
): RecordProgressPointsPayload! @topic(names: ["workflows"])
"""
Void or supersede a status event atomically. Preserves original history and records the authenticated actor. Requires workCenter:write permission.
"""
correctWorkCenterStatusEvent(
"""Event, audit reason and optional replacement"""
input: CorrectWorkCenterStatusEventInput!
): CorrectWorkCenterStatusEventPayload! @topic(names: ["jobs"])
"""
Record a work centre's status. A status is held until it changes: when it equals the current status, the current event's lastSeenAt is refreshed and that event is returned; otherwise a new event is appended. A timestamp before the current event's is recorded as history. Requires workCenter:write permission.
"""
recordWorkCenterStatusEvent(
"""Status event to record"""
input: RecordWorkCenterStatusEventInput!
): RecordWorkCenterStatusEventPayload! @topic(names: ["jobs"])
"""
Create a production report and any consumption rows. Requires productionReport:write.
"""
createProductionReport(
"""
The report to record, plus any consumption rows written in the same transaction. Vertical packages add further fields to this input; unknown fields are captured into the report's extensions blob.
"""
input: CreateProductionReportInput!
): CreateProductionReportPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.record-press-run"])
"""
Manually reclaim optional source details or closed production report chains. Tenant-scoped, bounded and preview-first; execution may partially succeed across entries. Receipts, acceptance, inventory, costs and completions are retained.
"""
cleanupProductionActuals(
"""
Required exclusive UTC cutoff. Every report in a deleted chain must precede it.
"""
before: ISO8601!
"""Explicit source-details or report-chain reclamation."""
scope: ProductionActualsCleanupScope!
"""
Defaults to true. Preview performs authorization and eligibility checks without deleting data.
"""
dryRun: Boolean
"""
Heads/reports examined, 1...100; default 25. Chains longer than 1000 are blocked.
"""
limit: Int
"""Opaque continuation cursor returned by the preceding page."""
after: String
): ProductionActualsCleanupPayload! @topic(names: ["jobs"])
"""
Accept physical production once, with optional warehousing. Authorizes each retry and never infers inventory from observation counts.
"""
acceptProduction(
"""Report portion and explicit physical quantities to accept atomically."""
input: AcceptProductionInput!
): ProductionReportState! @topic(names: ["jobs"])
"""
Atomically relocate produced stock without merging holdings or changing total quantity. Every attempt is authorized, including retry replay.
"""
moveOperationProduct(
"""Source holding, destination, shared-unit quantity and retry identity."""
input: MoveOperationProductInput!
): WarehouseTransferState! @topic(names: ["logistics"])
"""
Record an immutable correction and, when warehoused, reduce only untouched original holdings. Never reverse consumed inputs or downstream-used products.
"""
correctProductionOutput(
"""
Original report, unused correction report, reason and positive output reductions.
"""
input: CorrectProductionInput!
): ProductionReportState! @topic(names: ["jobs"])
"""
Create a new membership without adopting an existing one. Requires team:write permission.
"""
createTeamMembership(
"""Team and existing user to bind"""
input: AddTeamMemberInput!
): CreateTeamMembershipPayload! @topic(names: ["admin", "iam"])
"""
Set a team member's role. Team admins administer the stacks the team owns. Requires team:write permission.
"""
setTeamMemberRole(
"""Team containing the membership"""
teamId: TeamID!
"""Member whose role changes"""
userId: UserID!
"""New role"""
role: TeamMemberRole!
): SetTeamMemberRolePayload! @topic(names: ["admin", "iam"])
"""
Delete only the membership, leaving the user and team intact. Requires team:write permission.
"""
deleteTeamMembership(
"""Membership identity to delete"""
id: TeamMembershipID!
): DeleteTeamMembershipPayload! @topic(names: ["admin", "iam"])
"""Create or update a team. Requires team:write permission."""
upsertTeam(
"""Team data"""
input: UpsertTeamInput!
): UpsertTeamPayload! @topic(names: ["admin", "iam"])
"""Create a new team. Requires team:write permission."""
createTeam(
"""Team data"""
input: CreateTeamInput!
): UpsertTeamPayload! @topic(names: ["admin", "iam"])
"""
Update a team. Only provided fields are changed. Requires team:write permission.
"""
updateTeam(
"""Team ID to update"""
id: TeamID!
"""Fields to update — only provided fields are changed"""
input: UpdateTeamInput!
): UpsertTeamPayload! @topic(names: ["admin", "iam"])
"""Delete a team. Requires team:delete permission."""
deleteTeam(
"""Team ID to delete"""
id: TeamID!
): DeletePayload! @topic(names: ["admin", "iam"])
"""Add a user to a team. Requires team:write permission."""
addTeamMember(
"""Add member input"""
input: AddTeamMemberInput!
): TeamMemberPayload! @topic(names: ["admin", "iam"])
"""Remove a user from a team. Requires team:write permission."""
removeTeamMember(
"""Remove member input"""
input: RemoveTeamMemberInput!
): TeamMemberPayload! @topic(names: ["admin", "iam"])
"""
Create or update a task definition. Requires taskDefinition:write permission.
"""
upsertTaskDefinition(
"""Task definition data"""
input: UpsertTaskDefinitionInput!
): UpsertTaskDefinitionPayload! @topic(names: ["admin"])
"""
Create a new task definition. Requires taskDefinition:write permission.
"""
createTaskDefinition(
"""Task definition data"""
input: CreateTaskDefinitionInput!
): UpsertTaskDefinitionPayload! @topic(names: ["admin"])
"""
Update a task definition. Only provided fields are changed. Requires taskDefinition:write permission.
"""
updateTaskDefinition(
"""Task definition ID to update"""
id: TaskDefinitionID!
"""Fields to update — only provided fields are changed"""
input: UpdateTaskDefinitionInput!
): UpsertTaskDefinitionPayload! @topic(names: ["admin"])
"""Delete a task definition. Requires taskDefinition:delete permission."""
deleteTaskDefinition(
"""Task definition ID to delete"""
id: TaskDefinitionID!
): DeletePayload! @topic(names: ["admin"])
"""Create a new task. Requires task:write permission."""
createTask(
"""Task data"""
input: CreateTaskInput!
): TaskPayload! @topic(names: ["jobs"])
"""
Edit task metadata without changing its lifecycle. Requires task:write permission.
"""
updateTask(
"""Existing task whose editable metadata should change."""
id: TaskID!
"""
Metadata edits with omission preserving current values and null clearing supported optional fields.
"""
input: UpdateTaskInput!
): TaskPayload! @topic(names: ["jobs"])
"""
Transition a task's status. Requires task:transition permission, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
"""
transitionTask(
"""Transition input"""
input: TransitionTaskInput!
): TaskPayload! @topic(names: ["jobs"])
"""
Complete a journey task with the result of the journey the caller ran. The result is checked against the journey's declared outputs; the journey's own steps already ran as the caller. Requires task:transition, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder. Repeating it with the same result returns the completed task.
"""
completeTaskFromJourney(
"""The journey task to complete"""
taskId: TaskID!
"""
The published version of the task's journey that the caller ran; its declared outputs check the result
"""
journeyVersionId: JourneyVersionID!
"""
The finished run's outputs: an object keyed by the journey's declared output keys (a resource output is { id, label })
"""
result: JSON!
): TaskPayload! @topic(names: ["jobs"])
"""Claim a team-assigned task. Requires task:claim permission."""
claimTask(
"""Task ID to claim"""
id: TaskID!
): TaskPayload! @topic(names: ["jobs"])
"""
Cancel a task. Requires task:transition permission, and the caller must be the assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
"""
cancelTask(
"""Task ID to cancel"""
id: TaskID!
): TaskPayload! @topic(names: ["jobs"])
"""
Create a personal to-do assigned to the caller (MANUAL, ALLOCATED). Any signed-in user; no permission needed.
"""
createMyTask(
"""The to-do"""
input: CreateMyTaskInput!
): TaskPayload! @topic(names: ["jobs"])
"""
Complete an open personal to-do directly, whatever the status order. Its owner or a task:write holder.
"""
completeMyTask(
"""Personal to-do to complete"""
id: TaskID!
): TaskPayload! @topic(names: ["jobs"])
"""
Release a claimed team task back to its team: clears the claim and returns it to CREATED. The claimer or a task:write holder.
"""
releaseTask(
"""Claimed task to release"""
id: TaskID!
): TaskPayload! @topic(names: ["jobs"])
"""
Delete a task. Requires task:delete permission. A task with logged time, voided entries included, is refused with code TASK_HAS_LOGGED_TIME: cancel it instead.
"""
deleteTask(
"""Task ID to delete"""
id: TaskID!
): DeletePayload! @topic(names: ["jobs"])
"""
Start a timer on an open task. A person runs one timer at a time: a timer running on another task is stopped first, in the same write. Starting it again on the same task returns the running timer. Two starts racing leave one timer; the other gets WRITE_CONFLICT. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
"""
startTaskTimer(
"""The open task to time"""
taskId: TaskID!
): TaskTimeEntryPayload! @topic(names: ["jobs"])
"""
Stop the caller's running timer on a task, recording the span between start and now. Only the timer's owner.
"""
stopTaskTimer(
"""The task the caller's timer runs on"""
taskId: TaskID!
): TaskTimeEntryPayload! @topic(names: ["jobs"])
"""
Discard the caller's running timer on a task: it is voided with no duration and stays on record. Only the timer's owner.
"""
discardTaskTimer(
"""The task the caller's timer runs on"""
taskId: TaskID!
): TaskTimeEntryPayload! @topic(names: ["jobs"])
"""
Log time spent on a task by hand. The assignee, the claimer, a member of the assigned team while unclaimed, or a task:write holder.
"""
logTaskTime(
"""
The task the time was spent on: open, or finished (completed, rejected or cancelled) within the last 30 days
"""
taskId: TaskID!
"""How long the work took, in seconds: 60 (1 minute) to 86400 (24 hours)"""
durationSeconds: Int!
"""
When the work ended (ISO8601); defaults to now. Up to 60 seconds ahead of the server is taken as now; further ahead is refused.
"""
endedAt: ISO8601
"""Optional note on what the time was spent on, up to 2000 characters"""
note: String
"""
How the time is recorded: MANUAL (the default) for a log by hand, COMPLETION for time logged when the task is marked done. TIMER is refused: only the timer records it. COMPLETION is refused with TIMER_RUNNING while the caller's timer runs on the task, since completing stops and costs that timer, and with COMPLETION_ALREADY_LOGGED when the caller already has a live COMPLETION entry on the task, open or finished (void it to log again).
"""
source: TaskTimeEntrySource
): TaskTimeEntryPayload! @topic(names: ["jobs"])
"""
Void a time entry: it stays on record but counts toward no total. To correct an entry, void it and log the time again. Voiding twice changes nothing. The person who logged it, or a task:write holder.
"""
voidTaskTimeEntry(
"""The time entry to void"""
id: TaskTimeEntryID!
"""Why the entry is voided, up to 500 characters"""
reason: String!
): TaskTimeEntryPayload! @topic(names: ["jobs"])
"""
Install a catalog template into the calling tenant, creating or updating the corresponding domain resource and recording the installation with ControlApp. Idempotent: re-installing an unchanged template returns the existing resource. Authorization is dynamic — the caller needs write permission on the resource kind the template installs (e.g. script:write for a SCRIPT template, workflow:write for a WORKFLOW one), so it is checked in the resolver once the template has been fetched. Failures are reported in the payload, not as GraphQL errors.
"""
installSharedResource(
"""
Required for workflow templates: execution bot user in the calling tenant.
"""
botUserId: UserID
"""
TypeID of the catalog template to install ("srt_01K…"). Its `resourceType` decides which write permission the caller must hold.
"""
templateId: SharedResourceTemplateID!
): InstallSharedResourcePayload! @topic(names: ["apps"])
"""
Create a capability, or replace an existing one wholesale when input.id is given. Unlike createCapability/updateCapability this does not reject a duplicate code. The capability is written under the caller's tenant. Requires capability:write permission.
"""
upsertCapability(
"""
The capability to create or replace. With input.id the existing capability is overwritten wholesale; without it a new one is created.
"""
input: UpsertCapabilityInput!
): UpsertCapabilityPayload! @topic(names: ["jobs"])
"""Create a new capability. Requires capability:write permission."""
createCapability(
"""
The capability to create. Its code must not already exist in the caller's tenant.
"""
input: CreateCapabilityInput!
): UpsertCapabilityPayload! @topic(names: ["jobs"])
"""
Update a capability. Only provided fields are changed. Requires capability:write permission.
"""
updateCapability(
"""
TypeID (prefix "cpb") of the capability to update. Returns a "capability not found" field error when the tenant cannot see it.
"""
id: CapabilityID!
"""
The fields to change. Omitted fields keep their current value; a changed code must not collide with another capability in the tenant.
"""
input: UpdateCapabilityInput!
): UpsertCapabilityPayload! @topic(names: ["jobs"])
"""
Delete a capability owned by the caller's tenant. Non-tenant-scoped capabilities cannot be deleted: the payload reports success: false instead. Requires capability:delete permission.
"""
deleteCapability(
"""TypeID (prefix "cpb") of the tenant-owned capability to delete."""
id: CapabilityID!
): DeleteCapabilityPayload! @topic(names: ["jobs"])
"""
Create or overwrite a shift definition in one call. When input.id names an existing definition its createdAt is preserved; otherwise a new "shd" TypeID is minted. Validation failures come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
"""
upsertShiftDefinition(
"""
Full state of the shift definition. Omit input.id to create; supply it to overwrite that definition in place.
"""
input: UpsertShiftDefinitionInput!
): UpsertShiftDefinitionPayload! @topic(names: ["jobs"])
"""
Create a new shift definition in the caller's tenant; the server mints its "shd" TypeID and timestamps. Validation failures come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
"""
createShiftDefinition(
"""Fields for the new shift definition."""
input: CreateShiftDefinitionInput!
): UpsertShiftDefinitionPayload! @topic(names: ["jobs"])
"""
Patch an existing shift definition and stamp updatedAt. An unknown id, and any validation failure, come back as payload errors rather than as a GraphQL error. Requires shiftDefinition:write permission.
"""
updateShiftDefinition(
"""TypeID (prefix "shd") of the shift definition to patch."""
id: ShiftDefinitionID!
"""Fields to change; omitted fields keep their current values."""
input: UpdateShiftDefinitionInput!
): UpsertShiftDefinitionPayload! @topic(names: ["jobs"])
"""
Delete a shift definition from the caller's tenant. Deleting one that does not exist is reported as success: false with an "id" error, not as a GraphQL error. Requires shiftDefinition:delete permission.
"""
deleteShiftDefinition(
"""TypeID (prefix "shd") of the shift definition to delete."""
id: ShiftDefinitionID!
): DeleteShiftDefinitionPayload! @topic(names: ["jobs"])
"""
Replaces a work centre's twin settings. This is the only route to them: the work centre's own create and update do not accept them. Requires workCenterBehaviorProfile:write permission.
"""
configureWorkCenterTwin(
"""The work centre whose twin to configure"""
workCenterId: WorkCenterID!
"""The whole settings; an omitted field is reset to the server default"""
input: WorkCenterTwinSettingsInput!
): ConfigureWorkCenterTwinPayload! @topic(names: ["jobs"])
"""
Create a work center, or fully overwrite an existing one when input.id matches one in the caller's tenant. Unlike updateWorkCenter this replaces every field, so omitted optional fields are cleared. Requires workCenter:write permission.
"""
upsertWorkCenter(
"""
Full work center state to write. Include id to overwrite an existing work center; omit it to create one.
"""
input: UpsertWorkCenterInput!
): UpsertWorkCenterPayload! @topic(names: ["jobs"])
"""Create a new work center. Requires workCenter:write permission."""
createWorkCenter(
"""
Attributes of the work center to create. Its id is generated by the server; externalId, when given, must not already be in use in this tenant.
"""
input: CreateWorkCenterInput!
): UpsertWorkCenterPayload! @topic(names: ["jobs"])
"""
Update a work center. Only provided fields are changed. Requires workCenter:write permission.
"""
updateWorkCenter(
"""TypeID (prefix "wcr") of the work center to update."""
id: WorkCenterID!
"""
Partial patch: only the fields present are written, the rest are left as-is.
"""
input: UpdateWorkCenterInput!
): UpsertWorkCenterPayload! @topic(names: ["jobs"])
"""
Permanently delete a work center from the caller's tenant. Returns success = false when no work center with that id exists. Prefer setting lifecycle = ARCHIVED to retire a work center that has production history. Requires workCenter:delete permission.
"""
deleteWorkCenter(
"""TypeID (prefix "wcr") of the work center to delete."""
id: WorkCenterID!
): DeleteWorkCenterPayload! @topic(names: ["jobs"])
"""
Assigns a capability to a work center with a server-generated id. Nothing is persisted if a constraint URI fails validation; the errors are returned instead. Requires workCenter:write permission.
"""
createWorkCenterCapability(
"""The work center, capability, and optional constraints to record."""
input: CreateWorkCenterCapabilityInput!
): UpsertWorkCenterCapabilityPayload! @topic(names: ["jobs"])
"""
Patches an existing work center capability assignment and refreshes its updatedAt. Returns an "id" error when no such assignment exists in the caller's tenant, and persists nothing if a constraint URI fails validation. Requires workCenter:write permission.
"""
updateWorkCenterCapability(
"""TypeID of the assignment to patch (prefix "wcc")."""
id: WorkCenterCapabilityID!
"""Fields to change; omitted fields keep their stored values."""
input: UpdateWorkCenterCapabilityInput!
): UpsertWorkCenterCapabilityPayload! @topic(names: ["jobs"])
"""
Creates or wholly overwrites a work center capability assignment. Unlike update, every field is taken from the input, so omitted constraints clear the stored list; an existing record keeps its original createdAt. Requires workCenter:write permission.
"""
upsertWorkCenterCapability(
"""
The full assignment to write; supply id to overwrite an existing one, omit it to create.
"""
input: UpsertWorkCenterCapabilityInput!
): UpsertWorkCenterCapabilityPayload! @topic(names: ["jobs"])
"""
Removes a capability assignment from a work center. Returns success: false with an "id" error when the assignment does not exist in the caller's tenant. Requires workCenter:write permission.
"""
deleteWorkCenterCapability(
"""TypeID of the assignment to remove (prefix "wcc")."""
id: WorkCenterCapabilityID!
): DeleteWorkCenterCapabilityPayload! @topic(names: ["jobs"])
"""Create a new work center ↔ device binding. Requires workCenter:write."""
createWorkCenterDevice(
"""
The work center, device, and priority/active flags for the new binding.
"""
input: CreateWorkCenterDeviceInput!
): UpsertWorkCenterDevicePayload! @topic(names: ["jobs"])
"""
Update a work center ↔ device binding. Only provided fields are changed. Requires workCenter:write.
"""
updateWorkCenterDevice(
"""
TypeID (prefix `wcd`) of the binding to update. Must exist in this tenant.
"""
id: WorkCenterDeviceID!
"""Fields to change; omitted fields keep their current values."""
input: UpdateWorkCenterDeviceInput!
): UpsertWorkCenterDevicePayload! @topic(names: ["jobs"])
"""
Bind a controller device to a work center (or update its priority/active flag). Requires workCenter:write.
"""
upsertWorkCenterDevice(
"""
The binding to create or update in place, matched by `id` when given and otherwise by (workCenterId, deviceId).
"""
input: UpsertWorkCenterDeviceInput!
): UpsertWorkCenterDevicePayload! @topic(names: ["jobs"])
"""Remove a work center ↔ device binding. Requires workCenter:write."""
deleteWorkCenterDevice(
"""
TypeID (prefix `wcd`) of the binding to remove. Removes only the binding — neither the work center nor the device is deleted.
"""
id: WorkCenterDeviceID!
): DeleteWorkCenterDevicePayload! @topic(names: ["jobs"])
"""
Creates a work center shift profile, or fully replaces an existing one when input.id is supplied (createdAt is preserved). Requires workCenter:write.
"""
upsertWorkCenterShiftProfile(
"""
The profile to write. Supplying an existing id replaces that profile's fields; omitting id creates a new one.
"""
input: UpsertWorkCenterShiftProfileInput!
): UpsertWorkCenterShiftProfilePayload! @topic(names: ["jobs"])
"""
Creates a new work center shift profile with a server-generated id. Requires workCenter:write.
"""
createWorkCenterShiftProfile(
"""The shift assignment to create for the work center."""
input: CreateWorkCenterShiftProfileInput!
): UpsertWorkCenterShiftProfilePayload! @topic(names: ["jobs"])
"""
Partially updates an existing work center shift profile. Returns an id error when no such profile exists in the caller's tenant. Requires workCenter:write.
"""
updateWorkCenterShiftProfile(
"""TypeID of the shift profile to update (prefix "wsp")."""
id: WorkCenterShiftProfileID!
"""The fields to change; omitted fields keep their current values."""
input: UpdateWorkCenterShiftProfileInput!
): UpsertWorkCenterShiftProfilePayload! @topic(names: ["jobs"])
"""
Permanently deletes a work center shift profile, so the work center no longer runs that shift definition over the profile's window. Requires workCenter:write.
"""
deleteWorkCenterShiftProfile(
"""TypeID of the shift profile to delete (prefix "wsp")."""
id: WorkCenterShiftProfileID!
): DeleteWorkCenterShiftProfilePayload! @topic(names: ["jobs"])
"""
Create a schedule scenario, or fully replace an existing one when input.id is given. Rejected when the target scenario is locked. Requires scheduleScenario:write permission.
"""
upsertScheduleScenario(
"""
Full scenario payload. Include id to overwrite an existing scenario, omit it to create one.
"""
input: UpsertScheduleScenarioInput!
): UpsertScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Create a new schedule scenario. Requires scheduleScenario:write permission.
"""
createScheduleScenario(
"""
Attributes of the scenario to create. Its id is generated by the server.
"""
input: CreateScheduleScenarioInput!
): UpsertScheduleScenarioPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.create-schedule"])
"""
Update a schedule scenario. Only provided fields are changed. Requires scheduleScenario:write permission.
"""
updateScheduleScenario(
"""
TypeID of the schedule scenario to update (prefix "sch"). An id outside the caller's tenant is reported as not found.
"""
id: ScheduleScenarioID!
"""Fields to change. Omitted fields keep their current values."""
input: UpdateScheduleScenarioInput!
): UpsertScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Permanently delete a schedule scenario. Requires scheduleScenario:delete permission.
"""
deleteScheduleScenario(
"""
TypeID of the schedule scenario to delete (prefix "sch"). An id outside the caller's tenant is reported as not found.
"""
id: ScheduleScenarioID!
): DeleteScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Freeze a schedule scenario by stamping lockedAt. Scenario edits and allocation writes are rejected until unlockScheduleScenario clears the lock. Fails if it is already locked. Requires scheduleScenario:write permission.
"""
lockScheduleScenario(
"""TypeID of the schedule scenario to lock (prefix "sch")."""
id: ScheduleScenarioID!
): LockScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Clear lockedAt so the scenario can be edited and published again. Fails if it is not locked. Requires scheduleScenario:write permission.
"""
unlockScheduleScenario(
"""TypeID of the schedule scenario to unlock (prefix "sch")."""
id: ScheduleScenarioID!
): LockScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Create a schedule allocation, or overwrite an existing one when input.id is supplied (createdAt is preserved). Requires scheduleScenario:write permission.
"""
upsertScheduleAllocation(
"""The allocation to create, or — when input.id is given — to overwrite."""
input: UpsertScheduleAllocationInput!
): UpsertScheduleAllocationPayload! @topic(names: ["jobs"])
"""
Create a new schedule allocation. Requires scheduleScenario:write permission.
"""
createScheduleAllocation(
"""The allocation to create. Its id is generated server-side."""
input: CreateScheduleAllocationInput!
): UpsertScheduleAllocationPayload! @topic(names: ["jobs"]) @topic_example(names: ["production.allocate-press"])
"""
Update a schedule allocation. Only provided fields are changed. Requires scheduleScenario:write permission.
"""
updateScheduleAllocation(
"""TypeID of the allocation to update ("sal_01K…")."""
id: ScheduleAllocationID!
"""The fields to change; omitted fields keep their current values."""
input: UpdateScheduleAllocationInput!
): UpsertScheduleAllocationPayload! @topic(names: ["jobs"])
"""
Delete a schedule allocation from its scenario. Returns success: false with an "id" error when no such allocation exists. Requires scheduleScenario:write permission.
"""
deleteScheduleAllocation(
"""TypeID of the allocation to delete ("sal_01K…")."""
id: ScheduleAllocationID!
): DeleteScheduleAllocationPayload! @topic(names: ["jobs"])
"""
Replace a job's entire operation dependency graph: all existing edges for the job are deleted and the supplied ones inserted, in a single transaction that also applies any operation scheduling preferences. Validation (endpoint scopes, no self-loops, no duplicates, no cycles) is atomic with the write; on failure nothing changes and the errors are returned in the payload. Requires operation:write permission.
"""
upsertOperationGraph(
"""
The job's complete edge set, plus optional operation scheduling-preference patches.
"""
input: UpsertOperationGraphInput!
): UpsertOperationGraphPayload! @topic(names: ["jobs"])
"""
Create a single operation dependency edge. Requires operation:write permission.
"""
createOperationEdge(
"""Operation edge data"""
input: CreateOperationEdgeInput!
): UpsertOperationGraphPayload! @topic(names: ["jobs"])
"""
Update a single operation dependency edge. Only provided fields are changed. Requires operation:write permission.
"""
updateOperationEdge(
"""Operation edge ID to update"""
id: OperationEdgeID!
"""Fields to update — only provided fields are changed"""
input: UpdateOperationEdgeInput!
): UpsertOperationGraphPayload! @topic(names: ["jobs"])
"""
Create or update a single operation item. Requires operation:write permission.
"""
upsertOperationItem(
"""
The item to write. Supplying `id` updates that item, merging omitted fields from the stored values; omitting `id` creates a new one.
"""
input: UpsertOperationItemInput!
): UpsertOperationItemPayload! @topic(names: ["jobs"])
"""Create a new operation item. Requires operation:write permission."""
createOperationItem(
"""
The item to create. A supplied externalId must be unused within the tenant, otherwise the mutation returns an errors entry rather than creating.
"""
input: CreateOperationItemInput!
): UpsertOperationItemPayload! @topic(names: ["jobs"])
"""
Update an operation item. Only provided fields are changed. Requires operation:write permission.
"""
updateOperationItem(
"""Operation item ID to update"""
id: OperationItemID!
"""Fields to update — only provided fields are changed"""
input: UpdateOperationItemInput!
): UpsertOperationItemPayload! @topic(names: ["jobs"])
"""
Batch upsert operation items for an operation (replaces all existing items). Requires operation:write permission.
"""
upsertOperationItems(
"""
The operation, its job, and the full item list to write. Runs in one transaction: existing items (and their edges) are deleted, then the supplied items are inserted as new PENDING items with fresh ids.
"""
input: UpsertOperationItemsInput!
): UpsertOperationItemsPayload! @topic(names: ["jobs"])
"""
Transition operation item to a new status. Requires operation:execute permission.
"""
transitionOperationItem(
"""
The item to move and its target status. A transition the state machine disallows is returned as an errors entry on `status`, not thrown.
"""
input: TransitionOperationItemInput!
): UpsertOperationItemPayload! @topic(names: ["jobs"])
"""Delete an operation item. Requires operation:delete permission."""
deleteOperationItem(
"""
The item to delete. Deletion is permanent and is not blocked by the item's status; an id outside the tenant reports not-found.
"""
input: DeleteOperationItemInput!
): DeletePayload! @topic(names: ["jobs"])
"""
Batch upsert item-level dependency edges. Requires operation:write permission.
"""
upsertOperationItemEdges(
"""
The job (and optional operation pair) to replace edges within, plus the edges that should exist there afterwards.
"""
input: UpsertOperationItemEdgesInput!
): UpsertOperationItemEdgesPayload! @topic(names: ["jobs"])
"""
Create a single item-level dependency edge. Requires operation:write permission.
"""
createOperationItemEdge(
"""
The job, the two item endpoints, and their owning operations for the new edge.
"""
input: CreateOperationItemEdgeInput!
): UpsertOperationItemEdgesPayload! @topic(names: ["jobs"])
"""
Patch a single item-level dependency edge. Requires operation:write permission.
"""
updateOperationItemEdge(
"""
TypeID of the edge to patch ("oie_01K…"). Resolved within the caller's tenant; an unknown id yields an "id" field error rather than an exception.
"""
id: OperationItemEdgeID!
"""The fields to change; omitted fields keep their current values."""
input: UpdateOperationItemEdgeInput!
): UpsertOperationItemEdgesPayload! @topic(names: ["jobs"])
"""
Update only quantities on one planned step without replacing its identity, schedule allocations, durations or legacy productionQuantity.
"""
updatePlannedOperationQuantities(
"""
Stored planned step to update in place; allocation references are preserved.
"""
id: PlannedOperationID!
"""Explicit workload and expected good-output quantities with units."""
input: PlannedOperationQuantitiesInput!
): PlannedOperationState! @topic(names: ["jobs"])
"""
Create or overwrite a production plan together with its full set of planned operations and edges, in one transaction. Children are replaced wholesale (delete-then-insert). Validation failures are returned in the payload's `errors` rather than thrown. Requires productionPlan:write permission.
"""
upsertProductionPlan(
"""
The plan and its complete set of planned operations and edges. Pass `id` to overwrite an existing plan; omit it to create a new version.
"""
input: UpsertProductionPlanInput!
): UpsertProductionPlanPayload! @topic(names: ["jobs"])
"""
Create a new production plan. Requires productionPlan:write permission.
"""
createProductionPlan(
"""The plan to create, with its planned operations and edges."""
input: CreateProductionPlanInput!
): UpsertProductionPlanPayload! @topic(names: ["jobs"])
"""
Update a production plan. Only provided fields are changed. Requires productionPlan:write permission.
"""
updateProductionPlan(
"""Production plan ID to update"""
id: ProductionPlanID!
"""Fields to update — only provided fields are changed"""
input: UpdateProductionPlanInput!
): UpsertProductionPlanPayload! @topic(names: ["jobs"])
"""
Rebuild a work centre's behaviour profile from its history now, writing a new version. Requires workCenterBehaviorProfile:write permission.
"""
refreshWorkCenterBehaviorProfile(
"""The work centre to rebuild"""
input: RefreshWorkCenterBehaviorProfileInput!
): RefreshWorkCenterBehaviorProfilePayload! @topic(names: ["jobs"])
"""
Queue a Monte-Carlo replay of a scenario's allocations against the work centres' learned behaviour profiles. Returns immediately with a QUEUED run; stream progress with scenarioSimulationProgress or poll scenarioSimulationRun. Requires scenarioSimulationRun:execute.
"""
simulateScheduleScenario(
"""The scenario to replay and sampling options"""
input: SimulateScheduleScenarioInput!
): SimulateScheduleScenarioPayload! @topic(names: ["jobs"])
"""
Cancel a queued or running simulation. The run ends CANCELLED; a run already in a terminal status is left unchanged and reported as a field error. Requires scenarioSimulationRun:execute.
"""
cancelScenarioSimulation(
"""The QUEUED or RUNNING run to cancel"""
id: ScenarioSimulationRunID!
): CancelScenarioSimulationPayload! @topic(names: ["jobs"])
"""
Start a background schedule optimization. Returns immediately with the run ID. Use scheduleOptimizationProgress subscription to stream progress.
"""
startScheduleOptimization(
"""Optimization configuration"""
input: StartOptimizationInput!
): StartOptimizationPayload! @topic(names: ["jobs"])
"""
Cancel a running schedule optimization. The run transitions to CANCELLED status.
"""
cancelScheduleOptimization(
"""ID of the optimization run to cancel"""
id: OptimizationRunID!
): CancelOptimizationPayload! @topic(names: ["jobs"])
"""Create or update a template. Requires template:write permission."""
upsertTemplate(
"""Template data"""
input: UpsertTemplateInput!
): UpsertTemplatePayload! @topic(names: ["workflows", "scripting"])
"""Create a new template. Requires template:write permission."""
createTemplate(
"""Template data"""
input: CreateTemplateInput!
): UpsertTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Update a template. Only provided fields are changed. Requires template:write permission.
"""
updateTemplate(
"""Template ID to update"""
id: TemplateID!
"""
Fields to update — only provided fields are changed; kind cannot be changed
"""
input: UpdateTemplateInput!
): UpsertTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Delete a template and all its versions. Requires template:delete permission.
"""
deleteTemplate(
"""Template ID to delete"""
id: TemplateID!
): DeleteTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Validate template syntax without saving. Requires template:read permission.
"""
validateTemplate(
"""Template content to validate"""
input: ValidateTemplateInput!
): ValidateTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Publish current template content as a new version. Requires template:write permission.
"""
publishTemplateVersion(
"""Version publish data"""
input: PublishTemplateVersionInput!
): PublishTemplateVersionPayload! @topic(names: ["workflows", "scripting"])
"""
Delete one version from a template's history. Fails when the version is the one the template is currently published at. Requires template:write permission.
"""
deleteTemplateVersion(
"""Template version ID to delete"""
id: TemplateVersionID!
): DeletePayload! @topic(names: ["workflows", "scripting"])
"""
Restore template content from a previous version. Requires template:write permission.
"""
restoreTemplateVersion(
"""Version restore data"""
input: RestoreTemplateVersionInput!
): UpsertTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Render a template with context data. Requires template:execute permission.
"""
renderTemplate(
"""Render input data"""
input: RenderTemplateInput!
): RenderTemplatePayload! @topic(names: ["workflows", "scripting"])
"""
Create or update an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
"""
upsertFile(
"""File data"""
input: UpsertFileInput!
): UpsertFilePayload! @topic(names: ["files"])
"""
Create an external-backed file. Cloud-backed files use requestFileUploads. Requires file:write permission.
"""
createFile(
"""File data"""
input: CreateFileInput!
): UpsertFilePayload! @topic(names: ["files"])
"""
Update a file. Only provided fields are changed. Requires file:write permission.
"""
updateFile(
"""File ID to update"""
id: FileID!
"""Fields to update — only provided fields are changed"""
input: UpdateFileInput!
): UpsertFilePayload! @topic(names: ["files"]) @topic_example(names: ["prepress.update-file"])
"""Delete a file. Requires file:delete permission."""
deleteFile(
"""ID of the file to delete"""
id: FileID!
): DeletePayload! @topic(names: ["files"])
"""
Allocate one or more cloud upload URLs. Requires file:write permission.
"""
requestFileUploads(
"""File metadata for the files to be uploaded"""
inputs: [RequestFileUploadInput!]!
): RequestFileUploadsPayload! @topic(names: ["files"]) @topic_example(names: ["prepress.request-upload"])
"""Mark one or more uploads as ready. Requires file:write permission."""
completeFileUploads(
"""Confirmations for previously-allocated uploads"""
inputs: [CompleteFileUploadInput!]!
): CompleteFileUploadsPayload! @topic(names: ["files"]) @topic_example(names: ["prepress.complete-upload"])
"""
Resolve a download URL. Managed cloud URLs are provider-signed; EXTERNAL URLs pass through unchanged with no Pulse signature or TTL, and report URLs require authentication at retrieval. Requires file:download permission.
"""
fileDownloadUrl(
"""File to resolve a download URL for"""
id: FileID!
): FileDownloadGrant! @topic(names: ["files"]) @topic_example(names: ["prepress.download-file"])
"""
Create a warehouse location in the caller's tenant and emit a created event. Returns validation errors instead of a location when the input is invalid. Requires warehouseLocation:write permission.
"""
createWarehouseLocation(
"""
Fields for the new location; unset optional fields take their defaults.
"""
input: CreateWarehouseLocationInput!
): WarehouseLocationPayload! @topic(names: ["logistics"])
"""
Apply a partial update to an existing warehouse location and emit an updated event. Returns an error payload when the id is unknown in the caller's tenant or the result fails validation. Requires warehouseLocation:write permission.
"""
updateWarehouseLocation(
"""TypeID ("wlc") of the warehouse location to update."""
id: WarehouseLocationID!
"""The fields to change; omitted fields keep their current values."""
input: UpdateWarehouseLocationInput!
): WarehouseLocationPayload! @topic(names: ["logistics"])
"""
Create or fully replace a warehouse location by id, preserving the original createdAt when it already exists, and emit an updated event. Because the whole state is written, omitted optional fields are reset to their defaults. Requires warehouseLocation:write permission.
"""
upsertWarehouseLocation(
"""
Full desired state of the location, optionally carrying the id of the location to replace.
"""
input: UpsertWarehouseLocationInput!
): WarehouseLocationPayload! @topic(names: ["logistics"])
"""
Delete a warehouse location from the caller's tenant and emit a deleted event. Reports a not-found result when no such location exists. Requires warehouseLocation:delete permission.
"""
deleteWarehouseLocation(
"""TypeID ("wlc") of the warehouse location to delete."""
id: WarehouseLocationID!
): DeletePayload! @topic(names: ["logistics"])
"""
Create or wholesale-replace a warehouse stock record in the caller's tenant: creates one when `input.id` is omitted or unknown, otherwise overwrites the existing record. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
"""
upsertWarehouseStock(
"""Full state of the stock record to write."""
input: UpsertWarehouseStockInput!
): WarehouseStockPayload! @topic(names: ["logistics"])
"""
Create a warehouse stock record in the caller's tenant with a server-assigned WarehouseStock TypeID. Returns validation errors rather than a record when the quantities are invalid. Emits a warehouse-stock created event. Requires write access to warehouse stock.
"""
createWarehouseStock(
"""State of the stock record to create."""
input: CreateWarehouseStockInput!
): WarehouseStockPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.record-opening-stock"])
"""
Patch an existing warehouse stock record in the caller's tenant. Returns an `id` error when the record does not exist, or validation errors when the patched quantities are invalid. Emits a warehouse-stock updated event. Requires write access to warehouse stock.
"""
updateWarehouseStock(
"""WarehouseStock TypeID (`wst_…`) of the record to patch."""
id: WarehouseStockID!
"""Fields to change; omitted fields keep their current value."""
input: UpdateWarehouseStockInput!
): WarehouseStockPayload! @topic(names: ["logistics"])
"""
Permanently delete a warehouse stock record from the caller's tenant. Reports not-found when no such record exists. Emits a warehouse-stock deleted event. Requires delete access to warehouse stock.
"""
deleteWarehouseStock(
"""WarehouseStock TypeID (`wst_…`) of the record to delete."""
id: WarehouseStockID!
): DeletePayload! @topic(names: ["logistics"])
"""
Final consumption: atomically debit source on-hand and reserved quantities and update reservation summary. Requires a resolved, active non-quarantined holding. Shares authority with allocated issueStockToProduction.
"""
consumeMaterialLot(
"""Partial consumption and expected cumulative counters"""
input: MaterialLotChangeInput!
): MaterialLotChangePayload! @topic(names: ["logistics"])
"""
Release commitment without consuming stock. Resolved lots release matching holding and reservation counters; unresolved lots change no stock. Release reopens demand, so a future reserveJobMaterials may allocate it again.
"""
releaseMaterialLot(
"""Partial release and expected cumulative counters"""
input: MaterialLotChangeInput!
): MaterialLotChangePayload! @topic(names: ["logistics"])
"""
Create a warehouse transfer, or wholly replace an existing one when input.id is supplied. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.
"""
upsertWarehouseTransfer(
"""
Full transfer to write, optionally carrying the id of the transfer to replace.
"""
input: UpsertWarehouseTransferInput!
): WarehouseTransferPayload! @topic(names: ["logistics"])
"""
Create a warehouse transfer in the caller's tenant. Returns validation errors instead of saving when source and destination match or quantity is not positive. Requires warehouseTransfer:write permission.
"""
createWarehouseTransfer(
"""The transfer to create."""
input: CreateWarehouseTransferInput!
): WarehouseTransferPayload! @topic(names: ["logistics"])
"""
Apply a partial update to an existing warehouse transfer. Returns an error payload when the transfer does not exist, and validation errors when the result would have a matching source and destination or a non-positive quantity. Requires warehouseTransfer:write permission.
"""
updateWarehouseTransfer(
"""TypeID of the transfer to update (prefix "wtr")."""
id: WarehouseTransferID!
"""The fields to change; omitted fields are left as they are."""
input: UpdateWarehouseTransferInput!
): WarehouseTransferPayload! @topic(names: ["logistics"])
"""
Permanently delete a warehouse transfer from the caller's tenant. Reports not-found rather than failing when no such transfer exists. Requires warehouseTransfer:delete permission.
"""
deleteWarehouseTransfer(
"""TypeID of the transfer to delete (prefix "wtr")."""
id: WarehouseTransferID!
): DeletePayload! @topic(names: ["logistics"])
"""Create or update a carrier. Requires carrier:write permission."""
upsertCarrier(
"""Carrier data"""
input: UpsertCarrierInput!
): UpsertCarrierPayload! @topic(names: ["logistics"])
"""Create a new carrier. Requires carrier:write permission."""
createCarrier(
"""Carrier data"""
input: CreateCarrierInput!
): UpsertCarrierPayload! @topic(names: ["logistics"])
"""
Update a carrier. Only provided fields are changed. Requires carrier:write permission.
"""
updateCarrier(
"""Carrier ID to update"""
id: CarrierID!
"""Fields to update — only provided fields are changed"""
input: UpdateCarrierInput!
): UpsertCarrierPayload! @topic(names: ["logistics"])
"""Delete a carrier. Requires carrier:delete permission."""
deleteCarrier(
"""Carrier ID to delete"""
id: CarrierID!
): DeletePayload! @topic(names: ["logistics"])
"""Create or update a shipment. Requires shipment:write permission."""
upsertShipment(
"""Shipment data"""
input: UpsertShipmentInput!
): UpsertShipmentPayload! @topic(names: ["logistics"])
"""Create a new shipment. Requires shipment:write permission."""
createShipment(
"""Shipment data"""
input: CreateShipmentInput!
): UpsertShipmentPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.create-shipment"])
"""
Update a shipment. Only provided fields are changed. Requires shipment:write permission.
"""
updateShipment(
"""Shipment ID to update"""
id: ShipmentID!
"""Fields to update — only provided fields are changed"""
input: UpdateShipmentInput!
): UpsertShipmentPayload! @topic(names: ["logistics"])
"""Delete a shipment. Requires shipment:delete permission."""
deleteShipment(
"""Shipment ID to delete"""
id: ShipmentID!
): DeletePayload! @topic(names: ["logistics"])
"""Create a new shipment package. Requires shipment:write permission."""
createShipmentPackage(
"""Shipment package data"""
input: CreateShipmentPackageInput!
): UpsertShipmentPackagePayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.add-package"])
"""
Update a shipment package. Only provided fields are changed. Requires shipment:write permission.
"""
updateShipmentPackage(
"""Shipment package ID to update"""
id: ShipmentPackageID!
"""Fields to update — only provided fields are changed"""
input: UpdateShipmentPackageInput!
): UpsertShipmentPackagePayload! @topic(names: ["logistics"])
"""
Create or update a shipment package. Requires shipment:write permission.
"""
upsertShipmentPackage(
"""Shipment package data"""
input: UpsertShipmentPackageInput!
): UpsertShipmentPackagePayload! @topic(names: ["logistics"])
"""Delete a shipment package. Requires shipment:delete permission."""
deleteShipmentPackage(
"""Shipment package ID to delete"""
id: ShipmentPackageID!
): DeletePayload! @topic(names: ["logistics"])
"""Create or update a shipment item. Requires shipment:write permission."""
upsertShipmentItem(
"""Shipment item data"""
input: UpsertShipmentItemInput!
): UpsertShipmentItemPayload! @topic(names: ["logistics"])
"""Create a new shipment item. Requires shipment:write permission."""
createShipmentItem(
"""Shipment item data"""
input: CreateShipmentItemInput!
): UpsertShipmentItemPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.add-shipment-item"])
"""
Update a shipment item. Only provided fields are changed. Requires shipment:write permission.
"""
updateShipmentItem(
"""Shipment item ID to update"""
id: ShipmentItemID!
"""Fields to update — only provided fields are changed"""
input: UpdateShipmentItemInput!
): UpsertShipmentItemPayload! @topic(names: ["logistics"])
"""Delete a shipment item. Requires shipment:delete permission."""
deleteShipmentItem(
"""Shipment item ID to delete"""
id: ShipmentItemID!
): DeletePayload! @topic(names: ["logistics"])
"""
createPlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
"""
createPlannedDelivery(
"""input"""
input: PlannedDeliveryInput!
): PlannedDeliveryPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.plan-delivery"])
"""
updatePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:write
"""
updatePlannedDelivery(
"""Typed resource identifier"""
id: PlannedDeliveryID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
"""Complete replacement; optional fields omitted here are cleared"""
input: PlannedDeliveryInput!
): PlannedDeliveryPayload! @topic(names: ["logistics"])
"""
deletePlannedDelivery; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
"""
deletePlannedDelivery(
"""Typed resource identifier"""
id: PlannedDeliveryID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
): DeletePayload! @topic(names: ["logistics"])
"""
createPlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
"""
createPlannedDeliveryItem(
"""input"""
input: PlannedDeliveryItemInput!
): PlannedDeliveryItemPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.plan-delivery-item"])
"""
updatePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:write
"""
updatePlannedDeliveryItem(
"""Typed resource identifier"""
id: PlannedDeliveryItemID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
"""Complete replacement; optional fields omitted here are cleared"""
input: PlannedDeliveryItemInput!
): PlannedDeliveryItemPayload! @topic(names: ["logistics"])
"""
deletePlannedDeliveryItem; structural validation only, no lifecycle gates. Requires plannedDelivery:delete
"""
deletePlannedDeliveryItem(
"""Typed resource identifier"""
id: PlannedDeliveryItemID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
): DeletePayload! @topic(names: ["logistics"])
"""
createShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
"""
createShipmentItemAllocation(
"""input"""
input: ShipmentItemAllocationInput!
): ShipmentItemAllocationPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.allocate-delivery"])
"""
updateShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:write and shipment:write
"""
updateShipmentItemAllocation(
"""Typed resource identifier"""
id: ShipmentItemAllocationID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
"""Complete replacement; optional fields omitted here are cleared"""
input: UpdateShipmentItemAllocationInput!
): ShipmentItemAllocationPayload! @topic(names: ["logistics"])
"""
deleteShipmentItemAllocation; structural validation only, no lifecycle gates. Requires plannedDelivery:delete and shipment:write
"""
deleteShipmentItemAllocation(
"""Typed resource identifier"""
id: ShipmentItemAllocationID!
"""Current version required for optimistic concurrency; stale writes fail"""
expectedVersion: Int!
): DeletePayload! @topic(names: ["logistics"])
"""
createFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
"""
createFulfillmentRequirement(
"""Input for this fulfillment specification"""
input: FulfillmentRequirementInput!
): FulfillmentRequirementPayload! @topic(names: ["logistics"])
"""
createCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
"""
createCustomerFulfillmentDefault(
"""Input for this fulfillment specification"""
input: CustomerFulfillmentDefaultInput!
): CustomerFulfillmentDefaultPayload! @topic(names: ["logistics"])
"""
updateCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
"""
updateCustomerFulfillmentDefault(
"""Id for this fulfillment specification"""
id: CustomerFulfillmentDefaultID!
"""Current version required for the operation"""
expectedVersion: Int!
"""Input for this fulfillment specification"""
input: CustomerFulfillmentDefaultInput!
): CustomerFulfillmentDefaultPayload! @topic(names: ["logistics"])
"""
retireFulfillmentRequirement; explicit structural operation, no lifecycle gating or execution side effects
"""
retireFulfillmentRequirement(
"""Id for this fulfillment specification"""
id: FulfillmentRequirementID!
"""Current version required for the operation"""
expectedVersion: Int!
): FulfillmentRequirementPayload! @topic(names: ["logistics"])
"""
retireCustomerFulfillmentDefault; explicit structural operation, no lifecycle gating or execution side effects
"""
retireCustomerFulfillmentDefault(
"""Id for this fulfillment specification"""
id: CustomerFulfillmentDefaultID!
"""Current version required for the operation"""
expectedVersion: Int!
): CustomerFulfillmentDefaultPayload! @topic(names: ["logistics"])
"""
resolveCustomerFulfillmentDefaults; explicit structural operation, no lifecycle gating or execution side effects
"""
resolveCustomerFulfillmentDefaults(
"""Owning planned delivery"""
plannedDeliveryId: PlannedDeliveryID!
"""
Explicit customer supplying defaults; never inferred from recipient or billing
"""
customerId: CustomerID!
"""Current version required for the operation"""
expectedVersion: Int!
): PlannedDeliveryPayload! @topic(names: ["logistics"])
"""
recordShipmentItemEvidence; validates structure and permissions without lifecycle gating
"""
recordShipmentItemEvidence(
"""input; explicit evidence operation"""
input: ShipmentItemEvidenceInput!
): ShipmentItemEvidencePayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.record-receipt"])
"""
attributeShipmentItemEvidence; validates structure and permissions without lifecycle gating
"""
attributeShipmentItemEvidence(
"""evidenceId; explicit evidence operation"""
evidenceId: ShipmentItemEvidenceIDSpecTypedID!
"""expectedVersion; explicit evidence operation"""
expectedVersion: Int!
"""requestKey; explicit evidence operation"""
requestKey: String!
"""input; explicit evidence operation"""
input: ShipmentAttributionInput!
): ShipmentItemEvidencePayload! @topic(names: ["logistics"])
"""
Records evidence without running approvals, sending messages or enforcing lifecycle rules
"""
recordRequirementEvidence(
"""Version, scope, typed fact and retry identity"""
input: RecordRequirementEvidenceInput!
): RequirementEvidencePayload! @topic(names: ["logistics"])
"""
Save only the fulfillment section, preserving every other settings section
"""
updateFulfillmentSettings(
"""Completion policy; saving does not change any order or shipment"""
input: FulfillmentSettingsInput!
): UpdateFulfillmentSettingsPayload! @topic(names: ["admin", "logistics"])
"""
Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
"""
completeOrderFulfillment(
"""Active order to complete after atomic quantity assessment"""
orderId: OrderID!
"""Policy reviewed by caller; a changed setting requires review"""
expectedCompletionPoint: FulfillmentCompletionPoint!
): UpsertOrderPayload! @topic(names: ["commerce", "logistics"])
"""Save note changes independently of embedding success"""
createEntityNote(
"""input for the explicit note mutation"""
input: CreateEntityNoteInput!
): EntityNotePayload! @topic(names: ["jobs", "commerce", "logistics"]) @topic_example(names: ["commerce.add-order-note"])
"""Save note changes independently of embedding success"""
updateEntityNote(
"""id for the explicit note mutation"""
id: EntityNoteIDSpecTypedID!
"""expectedVersion for the explicit note mutation"""
expectedVersion: Int!
"""input for the explicit note mutation"""
input: UpdateEntityNoteInput!
): EntityNotePayload! @topic(names: ["jobs", "commerce", "logistics"])
"""Save note changes independently of embedding success"""
deleteEntityNote(
"""id for the explicit note mutation"""
id: EntityNoteIDSpecTypedID!
"""expectedVersion for the explicit note mutation"""
expectedVersion: Int!
): DeletePayload! @topic(names: ["jobs", "commerce", "logistics"])
"""Queue bounded recoverable indexing work using the current model"""
reindexEntityNotes(
"""Restrict authorized notes to reindex"""
filter: EntityNoteFilter
"""Maximum notes to enqueue; 1 through 200"""
first: Int
"""Continue from the previous reindex page"""
after: String
): EntityNoteReindexResult! @topic(names: ["jobs", "commerce", "logistics"])
"""Create or update an order. Requires order:write permission."""
upsertOrder(
"""Order data"""
input: UpsertOrderInput!
): UpsertOrderPayload! @topic(names: ["commerce"])
"""Create a new order. Requires order:write permission."""
createOrder(
"""Order data"""
input: CreateOrderInput!
): UpsertOrderPayload! @topic(names: ["commerce"])
"""
Update an order. Only provided fields are changed. Requires order:write permission.
"""
updateOrder(
"""Order ID to update"""
id: OrderID!
"""Fields to update — only provided fields are changed"""
input: UpdateOrderInput!
): UpsertOrderPayload! @topic(names: ["commerce"])
"""
Create a complete order — header, customer, billing/shipping addresses, and lines — in a single transaction. Each nested input reuses the same type as the corresponding individual upsert mutation; nested ids are rejected because this mutation is create-only. The resolver also enforces customer:write / address:write / orderline:write when those nested inputs are provided.
"""
createOrderGraph(
"""Converged order input including nested customer, addresses, and lines"""
input: CreateOrderGraphInput!
): CreateOrderGraphPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.create-order"])
"""Delete an order. Requires order:delete permission."""
deleteOrder(
"""Order ID to delete"""
id: OrderID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update an order line. Requires order:write permission."""
upsertOrderLine(
"""Order line data"""
input: UpsertOrderLineInput!
): UpsertOrderLinePayload! @topic(names: ["commerce"])
"""Create a new order line. Requires order:write permission."""
createOrderLine(
"""Order line data"""
input: CreateOrderLineInput!
): UpsertOrderLinePayload! @topic(names: ["commerce"])
"""
Update an order line. Only provided fields are changed. Requires order:write permission.
"""
updateOrderLine(
"""Order line ID to update"""
id: OrderLineID!
"""Fields to update — only provided fields are changed"""
input: UpdateOrderLineInput!
): UpsertOrderLinePayload! @topic(names: ["commerce"])
"""Delete an order line. Requires order:delete permission."""
deleteOrderLine(
"""Order line ID to delete"""
id: OrderLineID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update an estimate. Requires estimate:write permission."""
upsertEstimate(
"""Estimate data"""
input: UpsertEstimateInput!
): UpsertEstimatePayload! @topic(names: ["commerce"])
"""Create a new estimate. Requires estimate:write permission."""
createEstimate(
"""Estimate data"""
input: CreateEstimateInput!
): UpsertEstimatePayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.create-estimate"])
"""
Update an estimate. Only provided fields are changed. Requires estimate:write permission.
"""
updateEstimate(
"""Estimate ID to update"""
id: EstimateID!
"""Fields to update — only provided fields are changed"""
input: UpdateEstimateInput!
): UpsertEstimatePayload! @topic(names: ["commerce"])
"""Delete an estimate. Requires estimate:delete permission."""
deleteEstimate(
"""Estimate ID to delete"""
id: EstimateID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update an estimate line. Requires estimate:write permission."""
upsertEstimateLine(
"""Estimate line data"""
input: UpsertEstimateLineInput!
): UpsertEstimateLinePayload! @topic(names: ["commerce"])
"""Create a new estimate line. Requires estimate:write permission."""
createEstimateLine(
"""Estimate line data"""
input: CreateEstimateLineInput!
): UpsertEstimateLinePayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.add-estimate-line"])
"""
Update an estimate line. Only provided fields are changed. Requires estimate:write permission.
"""
updateEstimateLine(
"""Estimate line ID to update"""
id: EstimateLineID!
"""Fields to update — only provided fields are changed"""
input: UpdateEstimateLineInput!
): UpsertEstimateLinePayload! @topic(names: ["commerce"])
"""Delete an estimate line. Requires estimate:delete permission."""
deleteEstimateLine(
"""Estimate line ID to delete"""
id: EstimateLineID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update an invoice. Requires invoice:write permission."""
upsertInvoice(
"""Invoice data"""
input: UpsertInvoiceInput!
): UpsertInvoicePayload! @topic(names: ["commerce"])
"""Create a new invoice. Requires invoice:write permission."""
createInvoice(
"""Invoice data for new invoice"""
input: CreateInvoiceInput!
): UpsertInvoicePayload! @topic(names: ["commerce"])
"""Update an existing invoice. Requires invoice:write permission."""
updateInvoice(
"""Invoice ID to update"""
id: InvoiceID!
"""Invoice fields to update (patch semantics)"""
input: UpdateInvoiceInput!
): UpsertInvoicePayload! @topic(names: ["commerce"])
"""Delete an invoice. Requires invoice:delete permission."""
deleteInvoice(
"""Invoice ID to delete"""
id: InvoiceID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update an invoice line. Requires invoice:write permission."""
upsertInvoiceLine(
"""Invoice line data"""
input: UpsertInvoiceLineInput!
): UpsertInvoiceLinePayload! @topic(names: ["commerce"])
"""Create a new invoice line. Requires invoice:write permission."""
createInvoiceLine(
"""Invoice line data"""
input: CreateInvoiceLineInput!
): UpsertInvoiceLinePayload! @topic(names: ["commerce"])
"""
Update an invoice line. Only provided fields are changed. Requires invoice:write permission.
"""
updateInvoiceLine(
"""Invoice line ID to update"""
id: InvoiceLineID!
"""Fields to update — only provided fields are changed"""
input: UpdateInvoiceLineInput!
): UpsertInvoiceLinePayload! @topic(names: ["commerce"])
"""Delete an invoice line. Requires invoice:delete permission."""
deleteInvoiceLine(
"""Invoice line ID to delete"""
id: InvoiceLineID!
): DeletePayload! @topic(names: ["commerce"])
"""
Record a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (`paidAmount`, `paid`/`partiallyPaid`, `paidAt`) and its order (`paymentStatus`), atomically. Requires payment:write permission.
"""
recordPayment(
"""
The invoice being paid and the amount, plus the optional ledger detail (currency, method, reference, notes, receipt date) and the invoice-level payment method/reference.
"""
input: OTCRecordPaymentInput!
): OTCRecordPaymentPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.record-payment"])
"""Delete a payment record. Requires payment:delete permission."""
deletePayment(
"""Payment ID to delete"""
id: PaymentID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update a supplier. Requires supplier:write permission."""
upsertSupplier(
"""Supplier data"""
input: UpsertSupplierInput!
): UpsertSupplierPayload! @topic(names: ["commerce"])
"""Create a new supplier. Requires supplier:write permission."""
createSupplier(
"""Supplier data"""
input: CreateSupplierInput!
): UpsertSupplierPayload! @topic(names: ["commerce"])
"""
Update a supplier. Only provided fields are changed. Requires supplier:write permission.
"""
updateSupplier(
"""Supplier ID to update"""
id: SupplierID!
"""Fields to update — only provided fields are changed"""
input: UpdateSupplierInput!
): UpsertSupplierPayload! @topic(names: ["commerce"])
"""Delete a supplier. Requires supplier:delete permission."""
deleteSupplier(
"""Supplier ID to delete"""
id: SupplierID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update a purchase order. Requires purchaseOrder:write permission.
"""
upsertPurchaseOrder(
"""Purchase order data"""
input: UpsertPurchaseOrderInput!
): UpsertPurchaseOrderPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.create-purchase-order"])
"""
Update a purchase order. Only provided fields are changed. Requires purchaseOrder:write permission.
"""
updatePurchaseOrder(
"""Purchase order ID to update"""
id: PurchaseOrderID!
"""Fields to update — only provided fields are changed"""
input: UpdatePurchaseOrderInput!
): UpsertPurchaseOrderPayload! @topic(names: ["commerce"])
"""Delete a purchase order. Requires purchaseOrder:delete permission."""
deletePurchaseOrder(
"""Purchase order ID to delete"""
id: PurchaseOrderID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update a purchase order line. Requires purchaseOrder:write permission.
"""
upsertPurchaseOrderLine(
"""Purchase order line data"""
input: UpsertPurchaseOrderLineInput!
): UpsertPurchaseOrderLinePayload! @topic(names: ["commerce"])
"""
Create a new purchase order line. Requires purchaseOrder:write permission.
"""
createPurchaseOrderLine(
"""Purchase order line data"""
input: CreatePurchaseOrderLineInput!
): UpsertPurchaseOrderLinePayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.add-purchase-order-line"])
"""
Update a purchase order line. Only provided fields are changed. Requires purchaseOrder:write permission.
"""
updatePurchaseOrderLine(
"""Purchase order line ID to update"""
id: PurchaseOrderLineID!
"""Fields to update — only provided fields are changed"""
input: UpdatePurchaseOrderLineInput!
): UpsertPurchaseOrderLinePayload! @topic(names: ["commerce"])
"""
Delete a purchase order line. Requires purchaseOrder:delete permission.
"""
deletePurchaseOrderLine(
"""Purchase order line ID to delete"""
id: PurchaseOrderLineID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update a product. Requires product:write permission."""
upsertProduct(
"""Product data"""
input: UpsertProductInput!
): UpsertProductPayload! @topic(names: ["commerce"])
"""Create a new product. Requires product:write permission."""
createProduct(
"""Product data"""
input: CreateProductInput!
): UpsertProductPayload! @topic(names: ["commerce"])
"""
Update a product. Only provided fields are changed. Requires product:write permission.
"""
updateProduct(
"""Product ID to update"""
id: ProductID!
"""Fields to update — only provided fields are changed"""
input: UpdateProductInput!
): UpsertProductPayload! @topic(names: ["commerce"])
"""Delete a product. Requires product:delete permission."""
deleteProduct(
"""Product ID to delete"""
id: ProductID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update a job material reservation. Requires jobMaterialReservation:write permission.
"""
upsertJobMaterialReservation(
"""Reservation data"""
input: UpsertJobMaterialReservationInput!
): UpsertJobMaterialReservationPayload! @topic(names: ["logistics"])
"""
Create a new job material reservation. Requires jobMaterialReservation:write permission.
"""
createJobMaterialReservation(
"""Reservation data"""
input: CreateJobMaterialReservationInput!
): UpsertJobMaterialReservationPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.request-material"])
"""
Update a job material reservation. Only provided fields are changed. Requires jobMaterialReservation:write permission.
"""
updateJobMaterialReservation(
"""Reservation ID to update"""
id: JobMaterialReservationID!
"""Fields to update — only provided fields are changed"""
input: UpdateJobMaterialReservationInput!
): UpsertJobMaterialReservationPayload! @topic(names: ["logistics"])
"""
Delete a job material reservation. Requires jobMaterialReservation:delete permission.
"""
deleteJobMaterialReservation(
"""Reservation ID to delete"""
id: JobMaterialReservationID!
): DeletePayload! @topic(names: ["logistics"])
"""
Attempt to reserve warehouse stock for all pending material reservations on a job. Requires jobMaterialReservation:write permission.
"""
reserveJobMaterials(
"""Job ID to process reservations for"""
input: ReserveJobMaterialsInput!
): ReserveJobMaterialsPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.reserve-material"])
"""
Convert an accepted estimate into an order with order lines. Requires order:write.
"""
convertEstimateToOrder(
"""
Estimate to convert, plus optional overrides for the order's number, date and notes.
"""
input: ConvertEstimateToOrderInput!
): ConvertEstimateToOrderPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.convert-estimate"])
"""
Create a new revision of an estimate, copying all lines. Requires estimate:write.
"""
reviseEstimate(
"""Estimate to supersede, plus optional notes for the new revision."""
input: ReviseEstimateInput!
): ReviseEstimatePayload! @topic(names: ["commerce"])
"""Create jobs from order lines. Requires job:write."""
createJobsFromOrder(
"""Order to produce, and the per-order-line jobs to create from it."""
input: CreateJobsFromOrderInput!
): CreateJobsFromOrderPayload! @topic(names: ["commerce", "jobs"]) @topic_example(names: ["commerce.create-production-jobs"])
"""
Accept an estimate and create order + jobs with components/operations from production blueprints. Requires order:write.
"""
acceptEstimateAndCreateJobs(
"""
Estimate to accept, plus optional order number, date, notes and job priority.
"""
input: AcceptEstimateInput!
): AcceptEstimatePayload! @topic(names: ["commerce", "jobs"])
"""
Generate an invoice from an order and its lines. Rejects orders that already have an invoice, including concurrent retries. Requires invoice:write.
"""
invoiceOrder(
"""
Order to invoice, its invoice number, and optional dates, terms and notes.
"""
input: InvoiceOrderInput!
): InvoiceOrderPayload! @topic(names: ["commerce"]) @topic_example(names: ["commerce.invoice-order"])
"""Issue a credit note against an invoice. Requires invoice:write."""
issueCreditNote(
"""
Invoice to credit, the credit-note number, a reason, and optional partial-credit lines.
"""
input: IssueCreditNoteInput!
): IssueCreditNotePayload! @topic(names: ["commerce"])
"""
Create a shipment with packages and items, marking it as picked up. Requires shipment:write.
"""
dispatchShipment(
"""The shipment header plus every package and item to create with it."""
input: DispatchShipmentInput!
): DispatchShipmentPayload! @topic(names: ["logistics"])
"""Update shipment status and tracking details. Requires shipment:write."""
updateShipmentTracking(
"""
The shipment to update, its new status, and any tracking details to set.
"""
input: UpdateShipmentTrackingInput!
): UpdateShipmentTrackingPayload! @topic(names: ["logistics"])
"""
Create a purchase order with lines, computing totals automatically. Requires purchaseOrder:write.
"""
createPurchaseOrder(
"""The supplier, PO number, currency and lines of the order to create."""
input: CreatePurchaseOrderInput!
): CreatePurchaseOrderPayload! @topic(names: ["logistics"])
"""
Record receipt of purchase order lines, optionally adding to warehouse stock. Requires purchaseOrder:write.
"""
receivePurchaseOrder(
"""
The purchase order being delivered against, the quantities received per line, and optionally the warehouse location to put the goods away into.
"""
input: ReceivePurchaseOrderInput!
): ReceivePurchaseOrderPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.receive-paper"])
"""
Issue warehouse stock to production, creating transfers and reducing quantities. Requires warehouseStock:write.
"""
issueStockToProduction(
"""
The stock records to draw down, how much of each to issue, and the job the stock is consumed by.
"""
input: IssueStockToProductionInput!
): IssueStockToProductionPayload! @topic(names: ["logistics", "jobs"])
"""
Perform a stock count, adjusting quantities and recording differences. Requires warehouseStock:write.
"""
performStockCount(
"""
The warehouse location being counted and the quantity physically found for each of its stock records.
"""
input: PerformStockCountInput!
): PerformStockCountPayload! @topic(names: ["logistics"]) @topic_example(names: ["logistics.count-stock"])
"""
Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines. Requires estimate:write permission.
"""
generateEstimate(
"""
Customer, commercial terms (currency, margin, tax, validity), and the items to quote — each item's spec drives operation inference and cost calculation.
"""
input: GenerateEstimateInput!
): GenerateEstimatePayload! @topic(names: ["commerce"])
"""
Export the tenant's cost configuration (categories, rates, operation mappings) as a flat CSV string for spreadsheet editing.
"""
exportCostConfiguration: ExportCostConfigurationPayload! @topic(names: ["costing"])
"""
Import cost configuration from a CSV string. Upserts cost categories, operation-to-category mappings, and cost rates in a single transaction.
"""
importCostConfiguration(
"""
The CSV to import and the merge mode to apply. Rate values are interpreted as an amount in the row's ISO 4217 currency (defaulting to EUR when blank) per one of the cost category's units (e.g. 75.0 / EUR / HOURS = EUR 75 per hour).
"""
input: ImportCostConfigurationInput!
): ImportCostConfigurationPayload! @topic(names: ["costing"])
"""Update the status of multiple orders at once. Requires order:write."""
bulkUpdateOrderStatuses(
"""
The orders to move, the status to apply, and an optional internal note. Unknown order ids do not abort the batch — they come back in failedOrderIds.
"""
input: BulkUpdateOrderStatusesInput!
): BulkUpdateOrderStatusesPayload! @topic(names: ["commerce"])
"""
Duplicate an estimate for a different customer, optionally adjusting prices. Requires estimate:write.
"""
duplicateEstimateForCustomer(
"""
The source estimate, the customer to re-issue it to, and optional overrides (estimate number, contact, billing address, price adjustment, notes).
"""
input: DuplicateEstimateForCustomerInput!
): DuplicateEstimateForCustomerPayload! @topic(names: ["commerce"])
"""
Validate a Lua script for syntax errors. Requires script:execute permission.
"""
validateLuaScript(
"""Lua source code to validate"""
script: String!
): ValidateScriptPayload! @topic(names: ["scripting"])
"""
Execute a Lua script in the playground sandbox. Requires script:execute permission.
"""
executeLuaScript(
"""Script execution input"""
input: ExecuteScriptInput!
): ExecuteScriptPayload! @topic(names: ["scripting"])
"""Create or update a data clip"""
upsertDataClip(
"""
Clip fields to write. Include `id` to overwrite an existing clip, omit it to create a new one.
"""
input: UpsertDataClipInput!
): UpsertDataClipPayload! @topic(names: ["apps"])
"""Create a new data clip"""
createDataClip(
"""Name, optional description and MicroSQL query for the new clip."""
input: CreateDataClipInput!
): UpsertDataClipPayload! @topic(names: ["apps"])
"""Update a data clip"""
updateDataClip(
"""
TypeID of the clip to update (e.g. "dcl_01K…"). Must exist in the caller's tenant.
"""
id: DataClipID!
"""Fields to change. Omitted fields are left untouched."""
input: UpdateDataClipInput!
): UpsertDataClipPayload! @topic(names: ["apps"])
"""Delete a data clip"""
deleteDataClip(
"""
TypeID of the clip to delete (e.g. "dcl_01K…"). Deletion also kills the clip's public export links.
"""
id: DataClipID!
): DeletePayload! @topic(names: ["apps"])
"""
Roll/regenerate the share token for a data clip, invalidating old links
"""
rollDataClipShareToken(
"""Identifies the clip whose share token is replaced."""
input: RollShareTokenInput!
): RollShareTokenPayload! @topic(names: ["apps"])
"""Queue one run per parameter object under an idempotent batch key."""
runReportBatch(
"""Configuration and parameter values for this operation."""
input: ReportBatchInput!
): ReportBatchPayload! @topic(names: ["reports"])
"""Queue a preview execution of an inline report definition."""
previewReport(
"""Configuration and parameter values for this operation."""
input: ReportOneShotInput!
): ReportRunPayload! @topic(names: ["reports", "reporting"])
"""
Execute an inline report definition without publishing a reusable report.
"""
runOneShotReport(
"""Configuration and parameter values for this operation."""
input: ReportOneShotInput!
): ReportRunPayload! @topic(names: ["reports", "reporting"])
"""Queue another attempt of a failed report run."""
retryReportRun(
"""Report run identifier."""
id: ReportRunID!
): ReportRunPayload! @topic(names: ["reports", "reporting"])
"""Archive a report from active authoring."""
archiveReport(
"""Report identifier."""
id: ReportID!
): ReportPayload! @topic(names: ["reports", "reporting"])
"""Create or update a report schedule."""
upsertReportSchedule(
"""Configuration and parameter values for this operation."""
input: ReportScheduleInput!
): ReportSchedulePayload! @topic(names: ["reports", "reporting"])
"""Pause future firings of a report schedule."""
pauseReportSchedule(
"""Report schedule identifier."""
id: ReportScheduleID!
): ReportSchedulePayload! @topic(names: ["reports", "reporting"])
"""Create or replace a report draft using XML source."""
upsertReportSource(
"""XML authoring values and observed revision."""
input: ReportSourceInput!
): ReportPayload! @topic(names: ["reports"])
"""Publish the specified report source with an exact-source precondition."""
publishReportSource(
"""Report to publish."""
id: ReportID!
"""Exact source approved for publication; rejects a different draft."""
sourceXML: String!
): ReportPayload! @topic(names: ["reports"])
"""Create a report or replace its editable draft."""
upsertReportDraft(
"""Configuration and parameter values for this operation."""
input: ReportDraftInput!
): ReportPayload! @topic(names: ["reports", "reporting"])
"""Validate and publish the current draft as an immutable version."""
publishReport(
"""Report identifier."""
id: ReportID!
): ReportVersionPayload! @topic(names: ["reports", "reporting"])
"""
Queue a run and return its durable ID immediately. Poll reportRun, then download reportArtifacts.
"""
runReport(
"""Configuration and parameter values for this operation."""
input: RunReportInput!
): ReportRunPayload! @topic(names: ["reports", "reporting"])
"""Request cancellation of a report execution."""
cancelReportRun(
"""Report run identifier."""
id: ReportRunID!
): ReportRunPayload! @topic(names: ["reports", "reporting"])
"""
Create or update an external schema. Triggers background processing. Requires externalSchema:write permission.
"""
upsertExternalSchema(
"""External schema data"""
input: UpsertExternalSchemaInput!
): UpsertExternalSchemaPayload! @topic(names: ["apps"])
"""
Create a new external schema. Triggers background processing. Requires externalSchema:write permission.
"""
createExternalSchema(
"""External schema data"""
input: CreateExternalSchemaInput!
): UpsertExternalSchemaPayload! @topic(names: ["apps"])
"""
Update an external schema. Only provided fields are changed. Triggers background processing if sourceText is changed. Requires externalSchema:write permission.
"""
updateExternalSchema(
"""External schema ID to update"""
id: ExternalSchemaID!
"""Fields to update — only provided fields are changed"""
input: UpdateExternalSchemaInput!
): UpsertExternalSchemaPayload! @topic(names: ["apps"])
"""
Delete an external schema and all its entries. Requires externalSchema:delete permission.
"""
deleteExternalSchema(
"""ID of the external schema to delete"""
id: ExternalSchemaID!
): DeletePayload! @topic(names: ["apps"])
"""
Create or replace an API definition and compile its types without I/O. Updates require the current revision. Compilation failures are saved with diagnostics.
"""
saveAPIClientDefinition(
"""API client definition identity."""
id: APIClientDefinitionID
"""Current definition revision; required for updates and deletion."""
expectedRevision: String
"""API definition to create or replace."""
input: APIClientDefinitionInput!
): SaveAPIClientDefinitionPayload! @topic(names: ["apps"])
"""Delete an API definition only when its current revision matches."""
deleteAPIClientDefinition(
"""API client definition identity."""
id: APIClientDefinitionID!
"""Current definition revision; required for updates and deletion."""
expectedRevision: String!
): DeletePayload! @topic(names: ["apps"])
"""
Update tenant configuration. Creates a new version. For SECRET entries with null value, the existing secret is preserved. Requires tenantConfig:write permission.
"""
updateConfig(
"""Config entries to set"""
input: UpdateConfigInput!
): UpdateConfigPayload! @topic(names: ["admin"])
"""
Delete a config key. Creates a new version. Requires tenantConfig:write permission.
"""
deleteConfigKey(
"""Config key to delete"""
key: String!
): DeleteConfigKeyPayload! @topic(names: ["admin"])
"""
Rollback to a previous config version. Creates a new version with the old data. Requires tenantConfig:write permission.
"""
rollbackConfig(
"""Version number to rollback to"""
version: Int!
): RollbackConfigPayload! @topic(names: ["admin"])
"""
Infer the required production operations for a component. Provide either componentId or spec. When imposing config is provided, returns full production-grade DAG.
"""
inferOperations(
"""
What to infer operations for: either componentId (fetches the component, job and section) or an inline spec. Verticals may contribute extra fields (e.g. print's imposing config).
"""
input: InferOperationsInput!
): ImposedOperationResultOutput! @topic(names: ["jobs"])
"""
Start the OAuth consent flow for a Google Drive or Dropbox backend. Persists a draft backend (status NEEDS_REAUTHORIZATION) and returns the provider consent URL to send the user to; the callback completes the draft. Requires storageBackend:write permission.
"""
createStorageBackendAuthorization(
"""
Which OAuth provider to connect, and the name/description for the backend the flow will produce.
"""
input: CreateStorageBackendAuthorizationInput!
): CreateStorageBackendAuthorizationPayload! @topic(names: ["files"])
"""
Create or update a storage backend in one call. Prefer createStorageBackend / updateStorageBackend, which have the same validation but distinct create/update semantics. Requires storageBackend:write permission.
"""
upsertStorageBackend(
"""
The backend to create (id omitted) or update (id present), including its kind-specific config.
"""
input: UpsertStorageBackendInput!
): UpsertStorageBackendPayload! @topic(names: ["files"])
"""
Create a new storage backend. Requires storageBackend:write permission.
"""
createStorageBackend(
"""The backend to create, including the credentials for its kind."""
input: CreateStorageBackendInput!
): UpsertStorageBackendPayload! @topic(names: ["files"])
"""
Update a storage backend. Only provided fields are changed. Requires storageBackend:write permission.
"""
updateStorageBackend(
"""Storage backend ID to update"""
id: StorageBackendID!
"""Fields to update — only provided fields are changed"""
input: UpdateStorageBackendInput!
): UpsertStorageBackendPayload! @topic(names: ["files"])
"""
Delete a storage backend. Returns a notFound payload when no such backend exists in the caller's tenant. Also the way to clean up a draft left behind by an abandoned OAuth flow. Requires storageBackend:delete permission.
"""
deleteStorageBackend(
"""TypeID (`sbk_` prefix) of the backend to delete."""
id: StorageBackendID!
): DeletePayload! @topic(names: ["files"])
"""
Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.
"""
testStorageBackend(
"""TypeID (`sbk_` prefix) of the backend to probe."""
id: StorageBackendID!
): StorageBackendProbeResult! @topic(names: ["files"])
"""
Create an archive job, or fully overwrite an existing one when `input.id` is given. Unlike updateArchiveJob, omitted optional fields fall back to the existing value and then to the default. Requires archiveJob:write permission.
"""
upsertArchiveJob(
"""
Full archive job definition; its `id` decides whether an existing job is overwritten or a new one created.
"""
input: UpsertArchiveJobInput!
): UpsertArchiveJobPayload! @topic(names: ["admin"])
"""Create a new archive job. Requires archiveJob:write permission."""
createArchiveJob(
"""Definition of the archive job to create."""
input: CreateArchiveJobInput!
): UpsertArchiveJobPayload! @topic(names: ["admin"])
"""
Update an archive job. Only provided fields are changed. Requires archiveJob:write permission.
"""
updateArchiveJob(
"""TypeID (prefix `arj`) of the archive job to update."""
id: ArchiveJobID!
"""Patch to apply; only the fields present are changed."""
input: UpdateArchiveJobInput!
): UpsertArchiveJobPayload! @topic(names: ["admin"])
"""
Delete an archive job, cancelling its schedule. Reports notFound if no such job exists for the tenant. Requires archiveJob:delete permission.
"""
deleteArchiveJob(
"""TypeID (prefix `arj`) of the archive job to delete."""
id: ArchiveJobID!
): DeletePayload! @topic(names: ["admin"])
"""
Run an archive job immediately, regardless of its schedule or isEnabled flag. Enqueues the work and returns a PENDING ArchiveExecution to poll; the run itself happens asynchronously. Requires an authenticated user and archiveJob:execute permission.
"""
runArchiveJob(
"""TypeID (prefix `arj`) of the archive job to run now."""
id: ArchiveJobID!
): RunArchiveJobPayload! @topic(names: ["admin"])
"""
Creates a folder in the caller's tenant. The binding reference must resolve to a storage backend or controller owned by the tenant, the name must be unique within it, and at most one folder may be the tenant default. Requires folder:write permission.
"""
createFolder(
"""Name, transport binding and root path for the new folder."""
input: CreateFolderInput!
): FolderPayload! @topic(names: ["files"])
"""
Patches a folder. Omitted fields are left unchanged. A folder that files already reference may not have its binding or root path changed (stored file handles would resolve against the wrong transport/prefix), and the tenant default may be moved to another folder but never simply unset. Requires folder:write permission.
"""
updateFolder(
"""Folder ID to update"""
id: FolderID!
"""The fields to change; omitted fields keep their stored values."""
input: UpdateFolderInput!
): FolderPayload! @topic(names: ["files"])
"""
Deletes a folder. Refused for the tenant default folder and for any folder still referenced by files — the stored bytes would be orphaned. Requires folder:delete permission.
"""
deleteFolder(
"""TypeID of the folder to delete (e.g. "fld_01K…")."""
id: FolderID!
): DeletePayload! @topic(names: ["files"])
"""
Checks a folder transport with a read-only stat probe. CONTROL_CLOUD reports UNKNOWN because its sentinel probe cannot verify tenant storage provisioning or remote reachability. Other bindings accept an absent sentinel as reachable; this does not test write permissions. Nothing is written, and no folder state changes. Requires folder:read permission.
"""
testFolder(
"""TypeID of the folder to probe (e.g. "fld_01K…")."""
id: FolderID!
): FolderProbeResult! @topic(names: ["files"])
"""Test credentials and required TLS without importing or sending mail."""
testInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Retrieval or SMTP connection to probe."""
purpose: MailboxCredentialPurpose!
): InboxProbeResult! @topic(names: ["files"])
"""Create a disabled mailbox configuration."""
createInboxFolder(
"""Complete configuration. Created disabled."""
input: InboxFolderInput!
): InboxFolderPayload! @topic(names: ["files"])
"""Replace a paused configuration using optimistic concurrency."""
updateInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Revision read by the caller."""
expectedRevision: Int
"""Replacement configuration; credentials are unchanged."""
input: InboxFolderInput!
): InboxFolderPayload! @topic(names: ["files"])
"""
Probe retrieval credentials and storage capabilities, then enable retrieval from a no-backlog baseline.
"""
enableInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Current configuration revision."""
expectedRevision: Int!
): InboxFolderPayload! @topic(names: ["files"])
"""Recheck retrieval and storage before resuming the saved cursor."""
resumeInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Current configuration revision."""
expectedRevision: Int!
): InboxFolderPayload! @topic(names: ["files"])
"""Pause polling and fence in-flight mailbox work."""
pauseInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Current configuration revision."""
expectedRevision: Int!
): InboxFolderPayload! @topic(names: ["files"])
"""
Terminally archive a mailbox, revoke its credentials, and preserve message/send evidence.
"""
archiveInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Current configuration revision."""
expectedRevision: Int!
): InboxFolderPayload! @topic(names: ["files"])
"""
Remove an empty archived configuration without deleting its storage Folder.
"""
deleteInboxFolder(
"""
Archived InboxFolder ID. Deletion succeeds only when no operational evidence remains.
"""
id: InboxFolderID!
): InboxFolderDeleteResult! @topic(names: ["files"])
"""
Replace a paused mailbox and reset its namespace without importing existing messages.
"""
rebindInboxFolder(
"""InboxFolder ID."""
id: InboxFolderID!
"""Current configuration revision."""
expectedRevision: Int!
"""
Replacement configuration after pausing; new retrieval identity starts at a baseline.
"""
input: InboxFolderInput!
): InboxFolderPayload! @topic(names: ["files"])
"""Store a mailbox credential without returning it."""
setInboxFolderCredential(
"""InboxFolder ID."""
id: InboxFolderID!
"""Write-only credential replacement."""
input: InboxCredentialInput!
): InboxCredentialResult! @topic(names: ["files"])
"""
Request fresh bounded parsing/scanning with an audited reason. Admission is never directly bypassed.
"""
releaseInboxMessage(
"""Held or quarantined message to recheck."""
id: InboxMessageID!
"""
Record operator approval for admission if the fresh checks pass; checks are never skipped.
"""
approveAdmission: Boolean!
"""Audited reason for the release."""
reason: String!
): InboxOperationResult! @topic(names: ["files"])
"""Acquire a bounded operator retention hold."""
holdInboxMessage(
"""Message whose content to hold."""
id: InboxMessageID!
"""Audited reason for the hold."""
reason: String!
"""How long the hold lasts, in seconds."""
seconds: Int!
): InboxOperationResult! @topic(names: ["files"])
"""Release this operator's retention hold with an audited reason."""
releaseInboxMessageHold(
"""Message whose hold to release."""
id: InboxMessageID!
"""Audited reason for the release."""
reason: String!
): InboxOperationResult! @topic(names: ["files"])
"""
Create one bounded new delivery generation for a currently enabled matching trigger.
"""
replayInboxDelivery(
"""Accepted message to deliver again."""
messageId: InboxMessageID!
"""Enabled workflow trigger that matches the message."""
triggerId: WorkflowTriggerID!
"""Audited reason for the replay."""
reason: String!
): InboxOperationResult! @topic(names: ["files"])
"""
Dismiss a pending or paused delivery and release its pending content hold atomically.
"""
dismissInboxDelivery(
"""Delivery identifier from inboxDeliveries."""
id: InboxDeliveryID!
"""Audited reason for the dismissal."""
reason: String!
): InboxOperationResult! @topic(names: ["files"])
"""
Approve the exact configured From address, SMTP settings and current submission credential.
"""
approveInboxSender(
"""Mailbox whose current sender settings to approve."""
inboxFolderId: InboxFolderID!
): InboxOperationResult! @topic(names: ["files"])
"""
Persist an idempotent reply request after fresh actor, sender, recipient, File and scan checks.
"""
requestInboxReply(
"""Approved mailbox to send from."""
inboxFolderId: InboxFolderID!
"""Primary recipient addresses."""
to: [String!]!
"""Copy recipient addresses."""
cc: [String!]
"""Subject line."""
subject: String!
"""Plain-text body."""
text: String!
"""Optional HTML body sent alongside the text."""
html: String
"""
Managed Files to attach; each must be readable by the caller and pass scanning.
"""
attachmentFileIds: [FileID!]
"""Accepted inbox message being answered, if any."""
sourceMessageId: InboxMessageID
"""Message-ID for the In-Reply-To header."""
inReplyTo: String
"""Message-IDs for the References header."""
references: [String!]
"""
Caller key; repeating a request with the same key returns the original outbound message.
"""
idempotencyKey: String!
): InboxOutboundStatus! @topic(names: ["files"])
"""
Audit an operator's confirmation or explicit resend decision for unknown delivery.
"""
resolveInboxOutbound(
"""Mailbox the outbound message belongs to."""
inboxFolderId: InboxFolderID!
"""Outbound message whose delivery is unknown."""
id: InboxOutboundID!
"""
CONFIRMED_SENT to record delivery, or AUTHORIZED_RESEND to allow another attempt.
"""
resolution: String!
"""Audited operator note explaining the decision."""
note: String!
): InboxOperationResult! @topic(names: ["files"])
"""
Manually author a concept in the ontology. Requires concept:write permission.
"""
createConcept(
"""The concept to create."""
input: CreateConceptInput!
): ConceptPayload! @topic(names: ["aiml"])
"""
Rename or reclassify an existing concept. Requires concept:write permission.
"""
updateConcept(
"""Concept ID to update"""
id: ConceptID!
"""The concept edit (label and/or kind)."""
input: UpdateConceptInput!
): ConceptPayload! @topic(names: ["aiml"])
"""Delete a concept. Requires concept:delete permission."""
deleteConcept(
"""Concept to delete."""
id: ConceptID!
): DeletePayload! @topic(names: ["aiml"])
"""
Contribute a knowledge note about a concept or an entity. Requires knowledgeNote:write permission.
"""
createKnowledgeNote(
"""The note to contribute."""
input: CreateKnowledgeNoteInput!
): KnowledgeNotePayload! @topic(names: ["aiml"])
"""
Edit a note's body or scope, or supersede it with a replacement. The attachment is immutable. Requires knowledgeNote:write permission.
"""
updateKnowledgeNote(
"""Knowledge note ID to update"""
id: KnowledgeNoteID!
"""The note edit (body, scope, or supersession)."""
input: UpdateKnowledgeNoteInput!
): KnowledgeNotePayload! @topic(names: ["aiml"])
"""
Endorse a note: increments its confirmation count (raising its retrieval trust weight) and promotes a PENDING note to LIVE. Requires knowledgeNote:write permission.
"""
confirmKnowledgeNote(
"""Note to confirm."""
id: KnowledgeNoteID!
): KnowledgeNotePayload! @topic(names: ["aiml"])
"""
Delete a note and any graph edges it sourced. Requires knowledgeNote:delete permission.
"""
deleteKnowledgeNote(
"""Note to delete."""
id: KnowledgeNoteID!
): DeletePayload! @topic(names: ["aiml"])
"""
Record that two notes contradict each other; the conflict is surfaced by `retrieveKnowledge` via `KnowledgeHit.contradicts`. Requires knowledgeNote:write permission.
"""
markKnowledgeNotesContradict(
"""First note in the contradicting pair."""
a: KnowledgeNoteID!
"""Second note in the contradicting pair."""
b: KnowledgeNoteID!
): KnowledgeNotePayload! @topic(names: ["aiml"])
"""
Remove a previously recorded contradiction between two notes. Requires knowledgeNote:write permission.
"""
unmarkKnowledgeNotesContradict(
"""First note in the pair."""
a: KnowledgeNoteID!
"""Second note in the pair."""
b: KnowledgeNoteID!
): KnowledgeNotePayload! @topic(names: ["aiml"])
"""
Capture a knowledge subgraph — concepts, a note, and instance/semantic edges — in one atomic transaction. The manual, deterministic core of knowledge capture; the Phase-2 LLM path produces this same input. `scope` is caller-controlled. Requires knowledgeNote:write permission.
"""
captureKnowledge(
"""The subgraph to capture."""
input: CaptureKnowledgeInput!
): CaptureKnowledgePayload! @topic(names: ["aiml"])
"""
Add or update an artwork file reference on a component. Requires componentArtworkFile:write permission.
"""
upsertComponentArtworkFile(
"""Artwork file reference data"""
input: UpsertComponentArtworkFileInput!
): UpsertComponentArtworkFilePayload! @topic(names: ["print.prepress"])
"""
Remove an artwork file reference from a component. Requires componentArtworkFile:delete permission.
"""
deleteComponentArtworkFile(
"""Artwork file reference to delete"""
input: DeleteComponentArtworkFileInput!
): DeleteComponentArtworkFilePayload! @topic(names: ["print.prepress"])
"""
Create a new component or BatchComponent imposition specification. Requires impositionSpec:write permission.
"""
createImpositionSpec(
"""Imposition spec data"""
input: CreateImpositionSpecInput!
): UpsertImpositionSpecPayload! @topic(names: ["print.prepress"])
"""
Update an existing component or BatchComponent imposition specification. Requires impositionSpec:write permission.
"""
updateImpositionSpec(
"""Imposition spec data"""
input: UpdateImpositionSpecInput!
): UpsertImpositionSpecPayload! @topic(names: ["print.prepress"])
"""
Add or update an imposition spec on a component or batch form. Requires impositionSpec:write permission.
"""
upsertImpositionSpec(
"""Imposition spec data"""
input: UpsertImpositionSpecInput!
): UpsertImpositionSpecPayload! @topic(names: ["print.prepress"])
"""
Remove an imposition spec from a component. Requires impositionSpec:delete permission.
"""
deleteImpositionSpec(
"""Imposition spec to delete"""
input: DeleteImpositionSpecInput!
): DeleteImpositionSpecPayload! @topic(names: ["print.prepress"])
"""
Calculate imposition layout for a component and create ImpositionSpec records. Finished size, bleed, page count, and quantity are read from the component. Requires impositionSpec:write permission.
"""
calculateImposition(
"""Imposition calculation parameters"""
input: CalculateImpositionInput!
): CalculateImpositionPayload! @topic(names: ["print.prepress"])
"""
Re-prepare and atomically retain immutable print product definitions and expected work. Requires operation write permission, impositionSpec read for book/sheet preparation or execute for inline rendering, and managed file download permission when applicable. Stable product IDs support safe retries; no stock is changed.
"""
retainPrintProducts(
"""
One preparation family and reviewed producer assignments, with optional existing consumer links.
"""
input: RetainPrintProductsInput!
): RetainedPrintProductsResult! @topic(names: ["print.prepress"])
"""
Revalidate existing input/work and atomically retain folded product definitions and expected outputs. Stable IDs support retries; stock and production reports are unchanged.
"""
retainFoldedProducts(
"""
Distinct reviewed folded outputs to retain atomically against existing input requirements.
"""
targets: [RetainFoldedProductTarget!]!
): RetainedPrintProductsResult! @topic(names: ["print.prepress"])
"""
Atomically retain separated product definitions, cutting setup, expected outputs and exact selected consumer bindings. Preserves other inputs and routes. Does not accept production or create stock; ordinary acceptance enforces cumulative separation yield.
"""
retainSignatureSeparation(
"""
Same separation selection, grouping and routes reviewed during preparation.
"""
input: SignatureSeparationInput!
"""
Unchanged preparation fingerprint; stale material, work or graph facts reject the transaction.
"""
expectedIdentity: String!
"""One stable product ID for every reviewed output key."""
targets: [RetainSeparatedSignatureTarget!]!
): RetainedPrintProductsResult! @topic(names: ["print.prepress"])
"""
Create or update a prepress operation on a component. Requires prepressOperation:write permission.
"""
upsertPrepressOperation(
"""Prepress operation data"""
input: UpsertPrepressOperationInput!
): UpsertPrepressOperationPayload! @topic(names: ["print.prepress"])
"""
Delete a prepress operation. Requires prepressOperation:delete permission.
"""
deletePrepressOperation(
"""Prepress operation to delete"""
input: DeletePrepressOperationInput!
): DeletePrepressOperationPayload! @topic(names: ["print.prepress"])
"""
Create or update a preflight report on a component. Requires preflightReport:write permission.
"""
upsertPreflightReport(
"""Preflight report data"""
input: UpsertPreflightReportInput!
): UpsertPreflightReportPayload! @topic(names: ["print.prepress"])
"""Delete a preflight report. Requires preflightReport:delete permission."""
deletePreflightReport(
"""Preflight report to delete"""
input: DeletePreflightReportInput!
): DeletePreflightReportPayload! @topic(names: ["print.prepress"])
"""
Run the PrepressKit preflight engine on an artwork file and persist the report. Requires preflightReport:write permission.
"""
runPreflight(
"""Artwork to preflight"""
input: RunPreflightInput!
): RunPreflightPayload! @topic(names: ["print.prepress"])
"""
Extract ISO 19593-1 production steps from an artwork file and derive Operations (optionally persisting them). Requires operation:write permission.
"""
extractProductionOperations(
"""Artwork to extract production operations from"""
input: ExtractProductionOperationsInput!
): ExtractProductionOperationsPayload! @topic(names: ["print.prepress"])
"""
Instantiate a published product template into a print job. Requires productTemplate:execute permission.
"""
instantiateProductTemplate(
"""Instantiation parameters"""
input: InstantiateProductTemplateInput!
): InstantiateProductTemplatePayload! @topic(names: ["print.prepress", "productTemplates"])
"""
Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
"""
installCanonicalTemplate(
"""Slug of the canonical template to install."""
input: InstallCanonicalTemplateInput!
): UpsertProductTemplatePayload! @topic(names: ["print.prepress", "productTemplates"])
"""
Create a new substrate, failing if the code is already taken. Requires substrate:write permission.
"""
createSubstrate(
"""Substrate data"""
input: CreateSubstrateInput!
): UpsertSubstratePayload! @topic(names: ["print.prepress"])
"""
Update a substrate in place. Only provided fields are changed. Requires substrate:write permission.
"""
updateSubstrate(
"""ID of the substrate to update"""
id: SubstrateID!
"""Fields to update — only provided fields are changed"""
input: UpdateSubstrateInput!
): UpsertSubstratePayload! @topic(names: ["print.prepress"])
"""Create or update a substrate. Requires substrate:write permission."""
upsertSubstrate(
"""Substrate data"""
input: UpsertSubstrateInput!
): UpsertSubstratePayload! @topic(names: ["print.prepress"])
"""Delete a substrate. Requires substrate:delete permission."""
deleteSubstrate(
"""ID of the substrate to delete"""
id: SubstrateID!
): DeletePayload! @topic(names: ["print.prepress"])
"""
Create a new substrate template line. Requires substrateTemplateLine:write permission.
"""
createSubstrateTemplateLine(
"""Substrate template line data"""
input: CreateSubstrateTemplateLineInput!
): UpsertSubstrateTemplateLinePayload! @topic(names: ["print.prepress"])
"""
Update a substrate template line in place. Only provided fields are changed. Requires substrateTemplateLine:write permission.
"""
updateSubstrateTemplateLine(
"""Substrate template line ID to update"""
id: SubstrateTemplateLineID!
"""Fields to update — only provided fields are changed"""
input: UpdateSubstrateTemplateLineInput!
): UpsertSubstrateTemplateLinePayload! @topic(names: ["print.prepress"])
"""
Create or update a substrate template line. Requires substrateTemplateLine:write permission.
"""
upsertSubstrateTemplateLine(
"""Substrate template line data"""
input: UpsertSubstrateTemplateLineInput!
): UpsertSubstrateTemplateLinePayload! @topic(names: ["print.prepress"])
"""
Delete a substrate template line. Requires substrateTemplateLine:delete permission.
"""
deleteSubstrateTemplateLine(
"""Substrate template line ID to delete"""
id: SubstrateTemplateLineID!
): DeletePayload! @topic(names: ["print.prepress"])
"""
Set or clear the imposition specification an operation runs. Requires operation:write and impositionSpec:read permission.
"""
setOperationImposition(
"""Operation and imposition specification"""
input: SetOperationImpositionInput!
): SetImpositionLinkPayload! @topic(names: ["print.prepress"])
"""
Set or clear the imposition specification one operation item (form) runs. Requires operation:write and impositionSpec:read permission.
"""
setOperationItemImposition(
"""Operation item and imposition specification"""
input: SetOperationItemImpositionInput!
): SetImpositionLinkPayload! @topic(names: ["print.prepress"])
"""
Discover the devices known to a JMF controller (KnownDevices). Requires device:execute permission.
"""
discoverDeviceJMFDevices(
"""ID of the JMF-enabled device whose controller to query"""
deviceId: DeviceID!
): DiscoverJMFDevicesPayload! @topic(names: ["print.jmf"])
"""
Interrogate the message services a JMF controller supports (KnownMessages). Requires device:execute permission.
"""
interrogateDeviceJMFCapabilities(
"""ID of the JMF-enabled device whose controller to query"""
deviceId: DeviceID!
): InterrogateJMFCapabilitiesPayload! @topic(names: ["print.jmf"])
"""
Configure the controller bridge JMF endpoint (generates basic-auth credentials when enabled). Direct /api/v1/jmf is configured separately with updateJmfSettings. Requires controller:write.
"""
setControllerJMFConfig(
"""
Desired JMF configuration; unset optional fields keep their current value (or fall back to the defaults on first configuration).
"""
input: SetControllerJMFConfigInput!
): SetControllerJMFConfigPayload! @topic(names: ["print.jmf"])
"""Remove a controller's JMF configuration. Requires controller:write."""
deleteControllerJMFConfig(
"""
TypeID (`ctl_…`) of the controller whose JMF config to remove. The controller itself is untouched.
"""
controllerId: ControllerID!
): DeleteControllerJMFConfigPayload! @topic(names: ["print.jmf"])
"""
Set the canonical JMF DeviceID on a work center ↔ device binding for inbound correlation. The legacy WorkCenter.jmfDeviceId remains a fallback alias; it is not copied because a work center can have several controller-specific IDs. Requires workCenter:write.
"""
setWorkCenterDeviceJMFDeviceID(
"""
Binding to address and the JMF DeviceID to store on it (null clears it; a blank string is rejected).
"""
input: SetWorkCenterDeviceJMFDeviceIDInput!
): SetWorkCenterDeviceJMFDeviceIDPayload! @topic(names: ["print.jmf"])
"""Saves the paper weight section. Other sections are untouched."""
updatePaperWeightSettings(
"""The new paper weight settings."""
input: PaperWeightSettingsInput!
): UpdatePaperWeightSettingsPayload! @topic(names: ["admin", "print.prepress"])
"""Saves the imposing section. Other sections are untouched."""
updateImposingSettings(
"""The new imposing settings."""
input: ImposingSettingsInput!
): UpdateImposingSettingsPayload! @topic(names: ["admin", "print.prepress"])
"""Turns the direct JMF endpoint on or off. The token is untouched."""
updateJmfSettings(
"""The new JMF endpoint settings."""
input: JmfSettingsInput!
): UpdateJmfSettingsPayload! @topic(names: ["admin", "print.jmf"])
"""
Sets or replaces the JMF access token with one you supply, e.g. the one your devices already send.
"""
setJmfToken(
"""The token to use."""
input: SetJmfTokenInput!
): UpdateJmfSettingsPayload! @topic(names: ["admin", "print.jmf"])
"""
Sets or replaces the JMF access token with a new random one, returned once in the result.
"""
generateJmfToken: JmfTokenPayload! @topic(names: ["admin", "print.jmf"])
"""
Removes the JMF access token. While the endpoint is on, anything that can reach it can then post signals.
"""
removeJmfToken: UpdateJmfSettingsPayload! @topic(names: ["admin", "print.jmf"])
"""
Shows the JMF access token so an operator can set up a device. Every reveal is recorded with who and when.
"""
revealJmfToken: JmfTokenPayload! @topic(names: ["admin", "print.jmf"])
"""
Retry unresolved or observed execution decisions under the current policy without duplicating progress.
"""
replayJMFExecutionObservation(
"""Observation fingerprint from ingestion diagnostics."""
fingerprint: String!
): JMFSubmissionPayload! @topic(names: ["print.jmf"])
"""
Registers a submission's execution targets and queue response for automatic JMF tracking.
"""
registerJMFSubmission(
"""Submission attempt and immutable target coverage."""
input: RegisterJMFSubmissionInput!
): JMFSubmissionPayload! @topic(names: ["print.jmf"])
"""
Import one completed, unambiguously scoped JDF process snapshot. XML is transient unless tenant debugging retention is enabled. Does not change execution, inventory or costs.
"""
importReturnedJDF(
"""The JDF snapshot and the operation it reports on."""
input: ImportReturnedJDFInput!
): ImportReturnedJDFPayload!
"""Create or update an address. Requires address:write permission."""
upsertAddress(
"""Address data"""
input: UpsertAddressInput!
): UpsertAddressPayload! @topic(names: ["commerce"])
"""Create a new address. Requires address:write permission."""
createAddress(
"""Address data"""
input: CreateAddressInput!
): UpsertAddressPayload! @topic(names: ["commerce"]) @topic_example(names: ["crm.add-shipping-address"])
"""
Update an address. Only provided fields are changed. Requires address:write permission.
"""
updateAddress(
"""Address ID to update"""
id: AddressID!
"""Fields to update — only provided fields are changed"""
input: UpdateAddressInput!
): UpsertAddressPayload! @topic(names: ["commerce"])
"""Delete an address. Requires address:delete permission."""
deleteAddress(
"""Address ID to delete"""
id: AddressID!
): DeleteAddressPayload! @topic(names: ["commerce"])
"""
Create or update a business unit. Requires businessunit:write permission.
"""
upsertBusinessUnit(
"""Business unit data"""
input: UpsertBusinessUnitInput!
): UpsertBusinessUnitPayload! @topic(names: ["commerce"])
"""Create a new business unit. Requires businessunit:write permission."""
createBusinessUnit(
"""Business unit data"""
input: CreateBusinessUnitInput!
): UpsertBusinessUnitPayload! @topic(names: ["commerce"])
"""
Update a business unit. Only provided fields are changed. Requires businessunit:write permission.
"""
updateBusinessUnit(
"""Business unit ID to update"""
id: BusinessUnitID!
"""Fields to update — only provided fields are changed"""
input: UpdateBusinessUnitInput!
): UpsertBusinessUnitPayload! @topic(names: ["commerce"])
"""Delete a business unit. Requires businessunit:delete permission."""
deleteBusinessUnit(
"""Business unit ID to delete"""
id: BusinessUnitID!
): DeletePayload! @topic(names: ["commerce"])
"""Create or update a contact. Requires contact:write permission."""
upsertContact(
"""Contact data"""
input: UpsertContactInput!
): UpsertContactPayload! @topic(names: ["commerce"])
"""Create a new contact. Requires contact:write permission."""
createContact(
"""Contact data"""
input: CreateContactInput!
): UpsertContactPayload! @topic(names: ["commerce"]) @topic_example(names: ["crm.add-customer-contact"])
"""
Update a contact. Only provided fields are changed. Requires contact:write permission.
"""
updateContact(
"""Contact ID to update"""
id: ContactID!
"""Fields to update — only provided fields are changed"""
input: UpdateContactInput!
): UpsertContactPayload! @topic(names: ["commerce"])
"""Delete a contact. Requires contact:delete permission."""
deleteContact(
"""Contact ID to delete"""
id: ContactID!
): DeleteContactPayload! @topic(names: ["commerce"])
"""
Create a new cost category, failing if the code is already taken. Requires costcategory:write permission.
"""
createCostCategory(
"""Cost category data"""
input: CreateCostCategoryInput!
): UpsertCostCategoryPayload! @topic(names: ["costing"])
"""
Update a cost category in place. Only provided fields are changed. Requires costcategory:write permission.
"""
updateCostCategory(
"""Cost category ID to update"""
id: CostCategoryID!
"""Fields to update — only provided fields are changed"""
input: UpdateCostCategoryInput!
): UpsertCostCategoryPayload! @topic(names: ["costing"])
"""
Create or update a cost category. Requires costcategory:write permission.
"""
upsertCostCategory(
"""Cost category data"""
input: UpsertCostCategoryInput!
): UpsertCostCategoryPayload! @topic(names: ["costing"])
"""Delete a cost category. Requires costcategory:delete permission."""
deleteCostCategory(
"""Cost category ID to delete"""
id: CostCategoryID!
): DeletePayload! @topic(names: ["costing"])
"""Create or update a cost center. Requires costcenter:write permission."""
upsertCostCenter(
"""Cost center data"""
input: UpsertCostCenterInput!
): UpsertCostCenterPayload! @topic(names: ["commerce"])
"""Create a new cost center. Requires costcenter:write permission."""
createCostCenter(
"""Cost center data"""
input: CreateCostCenterInput!
): UpsertCostCenterPayload! @topic(names: ["commerce"])
"""
Update a cost center. Only provided fields are changed. Requires costcenter:write permission.
"""
updateCostCenter(
"""Cost center ID to update"""
id: CostCenterID!
"""Fields to update — only provided fields are changed"""
input: UpdateCostCenterInput!
): UpsertCostCenterPayload! @topic(names: ["commerce"])
"""Delete a cost center. Requires costcenter:delete permission."""
deleteCostCenter(
"""Cost center ID to delete"""
id: CostCenterID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update a cost rate. Updates create a new version for audit trail. Requires costrate:write permission.
"""
upsertCostRate(
"""Cost rate data"""
input: UpsertCostRateInput!
): UpsertCostRatePayload! @topic(names: ["costing"])
"""
Create a new cost rate (always version 1). Requires costrate:write permission.
"""
createCostRate(
"""Cost rate data"""
input: CreateCostRateInput!
): UpsertCostRatePayload! @topic(names: ["costing"])
"""
Delete a cost rate nothing depends on. Refused, never cascaded, while recorded costs were priced with it or a later version replaces it; deleting the newest version makes the one it replaced current again. Requires costrate:delete permission.
"""
deleteCostRate(
"""Cost rate ID to delete"""
id: CostRateID!
): DeletePayload! @topic(names: ["costing"])
"""
Update a cost rate in place (does not create a new version, unlike upsertCostRate). Only provided fields are changed. Requires costrate:write permission.
"""
updateCostRate(
"""Cost rate ID to update"""
id: CostRateID!
"""Fields to update — only provided fields are changed"""
input: UpdateCostRateInput!
): UpsertCostRatePayload! @topic(names: ["costing"])
"""Create or update a customer. Requires customer:write permission."""
upsertCustomer(
"""Customer data"""
input: UpsertCustomerInput!
): UpsertCustomerPayload! @topic(names: ["commerce"])
"""Create a new customer. Requires customer:write permission."""
createCustomer(
"""Customer data"""
input: CreateCustomerInput!
): UpsertCustomerPayload! @topic(names: ["commerce"]) @topic_example(names: ["crm.register-customer"])
"""
Update a customer. Only provided fields are changed. Requires customer:write permission.
"""
updateCustomer(
"""Customer ID to update"""
id: CustomerID!
"""Fields to update — only provided fields are changed"""
input: UpdateCustomerInput!
): UpsertCustomerPayload! @topic(names: ["commerce"]) @topic_example(names: ["crm.update-customer-details", "crm.mark-customer-inactive"])
"""Delete a customer. Requires customer:delete permission."""
deleteCustomer(
"""Customer ID to delete"""
id: CustomerID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update a customer price override. Requires customerPriceOverride:write permission.
"""
upsertCustomerPriceOverride(
"""
Full override definition. When `input.id` is supplied the existing override is replaced field-for-field; when it is omitted a new override is created.
"""
input: UpsertCustomerPriceOverrideInput!
): UpsertCustomerPriceOverridePayload! @topic(names: ["commerce"])
"""
Create a new customer price override. Requires customerPriceOverride:write permission.
"""
createCustomerPriceOverride(
"""
Definition of the override to create. The id is server-assigned (a `cpo_` TypeID) and the override is scoped to the caller's tenant.
"""
input: CreateCustomerPriceOverrideInput!
): UpsertCustomerPriceOverridePayload! @topic(names: ["commerce"])
"""
Update a customer price override. Only provided fields are changed. Requires customerPriceOverride:write permission.
"""
updateCustomerPriceOverride(
"""
TypeID (`cpo_` prefix) of the override to update. Must belong to the caller's tenant; otherwise the mutation returns a not-found error.
"""
id: CustomerPriceOverrideID!
"""Patch to apply. Only fields present in the input are changed."""
input: UpdateCustomerPriceOverrideInput!
): UpsertCustomerPriceOverridePayload! @topic(names: ["commerce"])
"""
Delete a customer price override. Requires customerPriceOverride:delete permission.
"""
deleteCustomerPriceOverride(
"""
TypeID (`cpo_` prefix) of the override to delete. Deletion is permanent; deleting an id that is absent from the caller's tenant returns not-found.
"""
id: CustomerPriceOverrideID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create or update an operation cost mapping. Requires costcategory:write permission.
"""
upsertOperationCostMapping(
"""
The mapping to write. When `id` is present the existing mapping is fully replaced from these fields; when absent a new mapping is created.
"""
input: UpsertOperationCostMappingInput!
): UpsertOperationCostMappingPayload! @topic(names: ["costing"])
"""
Create a new operation cost mapping. Requires costcategory:write permission.
"""
createOperationCostMapping(
"""
Attributes of the new mapping. The id is server-assigned; `isActive` defaults to true when omitted.
"""
input: CreateOperationCostMappingInput!
): UpsertOperationCostMappingPayload! @topic(names: ["costing"])
"""
Update an operation cost mapping. Only provided fields are changed. Requires costcategory:write permission.
"""
updateOperationCostMapping(
"""
TypeID of the mapping to update ("ocm_01K…"). Must belong to the calling tenant, otherwise the mutation returns a not-found error.
"""
id: OperationCostMappingID!
"""The fields to change; omitted fields keep their current values."""
input: UpdateOperationCostMappingInput!
): UpsertOperationCostMappingPayload! @topic(names: ["costing"])
"""
Delete an operation cost mapping. Requires costcategory:delete permission.
"""
deleteOperationCostMapping(
"""
TypeID of the mapping to delete ("ocm_01K…"). Must belong to the calling tenant; deleting an unknown id returns a not-found error rather than succeeding silently.
"""
id: OperationCostMappingID!
): DeletePayload! @topic(names: ["costing"])
"""
Create or update a price bracket. Requires priceBracket:write permission.
"""
upsertPriceBracket(
"""Price bracket data"""
input: UpsertPriceBracketInput!
): UpsertPriceBracketPayload! @topic(names: ["commerce"])
"""Create a new price bracket. Requires priceBracket:write permission."""
createPriceBracket(
"""Price bracket data"""
input: CreatePriceBracketInput!
): UpsertPriceBracketPayload! @topic(names: ["commerce"])
"""
Update a price bracket. Only provided fields are changed. Requires priceBracket:write permission.
"""
updatePriceBracket(
"""Price bracket ID to update"""
id: PriceBracketID!
"""Fields to update — only provided fields are changed"""
input: UpdatePriceBracketInput!
): UpsertPriceBracketPayload! @topic(names: ["commerce"])
"""Delete a price bracket. Requires priceBracket:delete permission."""
deletePriceBracket(
"""Price bracket ID to delete"""
id: PriceBracketID!
): DeletePayload! @topic(names: ["commerce"])
"""
Create a production cell, or fully overwrite an existing one when input.id names one in the caller's tenant. Requires productionCell:write permission.
"""
upsertProductionCell(
"""The production cell to create or fully overwrite."""
input: UpsertProductionCellInput!
): UpsertProductionCellPayload! @topic(names: ["jobs"])
"""
Create a new production cell. Requires productionCell:write permission.
"""
createProductionCell(
"""The production cell to create."""
input: CreateProductionCellInput!
): UpsertProductionCellPayload! @topic(names: ["jobs"])
"""
Update a production cell. Only provided fields are changed. Requires productionCell:write permission.
"""
updateProductionCell(
"""TypeID (prefix "pcl") of the production cell to update."""
id: ProductionCellID!
"""The fields to change; omitted fields are left as they are."""
input: UpdateProductionCellInput!
): UpsertProductionCellPayload! @topic(names: ["jobs"])
"""
Delete a production cell. Work centers in the cell are kept but become ungrouped, and schedule scenarios targeting it lose that target. Requires productionCell:delete permission.
"""
deleteProductionCell(
"""TypeID (prefix "pcl") of the production cell to delete."""
id: ProductionCellID!
): DeleteProductionCellPayload! @topic(names: ["jobs"])
"""
Record an actual cost incurred. Requires recordedcost:write permission.
"""
upsertRecordedCost(
"""Recorded cost data"""
input: UpsertRecordedCostInput!
): UpsertRecordedCostPayload! @topic(names: ["costing"])
"""Create a new recorded cost. Requires recordedcost:write permission."""
createRecordedCost(
"""Recorded cost data"""
input: CreateRecordedCostInput!
): UpsertRecordedCostPayload! @topic(names: ["costing"]) @topic_example(names: ["erp.record-job-cost"])
"""
Update a recorded cost. Only provided fields are changed. Requires recordedcost:write permission.
"""
updateRecordedCost(
"""Recorded cost ID to update"""
id: RecordedCostID!
"""Fields to update — only provided fields are changed"""
input: UpdateRecordedCostInput!
): UpsertRecordedCostPayload! @topic(names: ["costing"]) @topic_example(names: ["erp.correct-job-cost"])
"""Delete a recorded cost. Requires recordedcost:delete permission."""
deleteRecordedCost(
"""Recorded cost ID to delete"""
id: RecordedCostID!
): DeletePayload! @topic(names: ["costing"])
"""Create or update a tax code. Requires taxCode:write permission."""
upsertTaxCode(
"""Tax code data"""
input: UpsertTaxCodeInput!
): UpsertTaxCodePayload! @topic(names: ["commerce"])
"""Create a new tax code. Requires taxCode:write permission."""
createTaxCode(
"""Tax code data"""
input: CreateTaxCodeInput!
): UpsertTaxCodePayload! @topic(names: ["commerce"])
"""
Update a tax code. Only provided fields are changed. Requires taxCode:write permission.
"""
updateTaxCode(
"""Tax code ID to update"""
id: TaxCodeID!
"""Fields to update — only provided fields are changed"""
input: UpdateTaxCodeInput!
): UpsertTaxCodePayload! @topic(names: ["commerce"])
"""Delete a tax code. Requires taxCode:delete permission."""
deleteTaxCode(
"""Tax code ID to delete"""
id: TaxCodeID!
): DeletePayload! @topic(names: ["commerce"])
}