Workflow Authoring
Workflow definitions, versions, triggers, executions and expression validation.
76 operations · complete schema 165 KB
magicQuery
Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
getMagicQuerySchema
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
listMagicQueries
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
getMagicQueryGraphQL
Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
listDataChangeEventTopics
List all valid data change event topics, grouped by resource. Requires authentication.
generateDefaultDataQuery
Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
ping
Health check endpoint
analyzeWorkflowSource
Compile XML and analyze shared workflow contracts without executing operations; JSON analysis result
getWorkflow
Fetch a single workflow by ID. Requires workflow:read permission.
listWorkflows
List workflows with pagination. Requires workflow:list permission.
getWorkflowVersionSource
Read authoritative workflow XML for IaC, including canonical exports of legacy versions
getWorkflowVersion
Fetch a single workflow version by ID. Requires workflow:read permission.
listWorkflowVersions
List workflow versions with pagination. Requires workflow:list permission.
getWorkflowSchema
Get the JSON Schema for workflow definitions. Can be used with Zod or other validation libraries. Requires workflow:read permission.
workflowTrigger
Get a workflow trigger by ID. Requires workflow:read permission.
workflowTriggers
List all triggers for a workflow. Requires workflow:list permission.
allWorkflowTriggers
List all triggers for the current tenant. Requires workflow:list permission.
getExecution
Fetch a single workflow execution by ID. Requires workflow:read permission.
listExecutions
List workflow executions with pagination. Requires workflow:list permission.
getExecutionSteps
Fetch all steps for a workflow execution. Requires workflow:read permission.
workflowExecutionRuntimeManagement
Inspect the exact workflow runner authority and audited recovery revision. Requires workflow:read permission.
workflowRunStats
Aggregate a workflow's runs over a time window: totals by status, duration percentiles, time buckets and per-node outcomes. Requires workflow:list permission.
workflowRunHealth
Run health of every workflow in the tenant that has a run since `since` or a run currently waiting: failures in the window, waiting runs and the latest run's status. Requires workflow:list permission.
listExecutionLogs
List execution log entries for a given context, newest first
queryProgressPoints
Query progress tracking points with time range and dimensional filters, keyset-paginated in descending timestamp order. Requires progressPoint:list permission.
latestProgress
Get the most recent progress snapshot for an operation. Requires progressPoint:read permission.
iacSchema
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacValidate
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iacGuides
Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
helpChapters
List human-facing manual chapters from the running deployment.
helpChapter
Read a chapter of the current published manual edition.
searchHelp
Search human-facing manuals using shared semantic and text retrieval.
schemaAuthoringCatalog
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
compileSchemaXML
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
renderSchemaXML
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
iacSchemaDocument
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
productionSnapshot
Read production resources with batched evidence. Also requires workCenter:read; cell, operation, progress and job permissions are checked independently.
getTemplate
Fetch a template by ID. Requires template:read permission.
getTemplateByHandle
Fetch a template by handle. Requires template:read permission.
listTemplates
List templates with pagination and filtering. Requires template:list permission.
getTemplateVersion
Fetch one template version by ID. Requires template:read permission.
listTemplateVersions
List versions of a template with pagination. Requires template:read permission.
createWorkflow
Create a new workflow. Requires workflow:write permission.
updateWorkflow
Update an existing workflow. Requires workflow:write permission.
deleteWorkflow
Delete a workflow and all its versions. Requires workflow:delete permission.
deleteWorkflowVersion
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.
deleteWorkflowVersionIfExists
Idempotent workflow version cleanup; retains the active-version protection
createWorkflowVersionFromSource
Create an immutable workflow version from XML; validation is shared with all authoring paths. Does not activate it.
createWorkflowVersion
Create a new version of a workflow. Requires workflow:write permission.
setActiveVersion
Set the active version of a workflow. Requires workflow:write permission.
exportWorkflow
Export a workflow version to YAML or JSON. Requires workflow:read permission.
importWorkflow
Import a workflow from YAML or JSON, creating a new version. Requires workflow:write permission.
validateWorkflow
Validate a workflow definition without importing it. Requires workflow:read permission.
createWorkflowTrigger
Create a new workflow trigger
updateWorkflowTrigger
Update an existing workflow trigger
deleteWorkflowTrigger
Delete a workflow trigger
enableWorkflowTrigger
Enable a workflow trigger
disableWorkflowTrigger
Disable a workflow trigger
executeWorkflow
Start a new workflow execution. Requires workflow:execute permission.
cancelExecution
Cancel a running workflow execution. Requires workflow:execute permission.
resumeWorkflowExecution
Resume a workflow execution that is waiting for an external signal. Requires workflow:execute permission.
reconcileWorkflowExecutionRuntime
Record authenticated, audited evidence that the exact predecessor process has terminated before workflow recovery. Requires workflow:reconcileRuntime permission.
resolveNodeOutputSchema
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.
validateJinja
Statically validate a workflow expression (parse + filter-name check) without evaluating it. Safe to call from editors on every keystroke.
recordProgressPoints
Record one or more progress tracking data points. Up to 10,000 points per request. Requires progressPoint:write permission.
upsertTemplate
Create or update a template. Requires template:write permission.
createTemplate
Create a new template. Requires template:write permission.
updateTemplate
Update a template. Only provided fields are changed. Requires template:write permission.
deleteTemplate
Delete a template and all its versions. Requires template:delete permission.
validateTemplate
Validate template syntax without saving. Requires template:read permission.
publishTemplateVersion
Publish current template content as a new version. Requires template:write permission.
deleteTemplateVersion
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.
restoreTemplateVersion
Restore template content from a previous version. Requires template:write permission.
renderTemplate
Render a template with context data. Requires template:execute permission.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.
executionLogStream
Stream execution log entries as they are written for a given context. Requires integrationInstance:read.