Workflow API Reference

Field	Value
Source spec	`workflow/openapi/v1.json`
OpenAPI version	`3.1.1`
API version	`1.0.0`
Operations	31
Path filter	All paths

Operations

`GET /api/v1/buildinfo`

API alias for /buildinfo.json (same payload).

Property	Value
Operation ID	`StellaOpsBuildInfoApi`
Tags	`StellaOps.Workflow.WebService`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/canonical/schema`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/canonical/validate`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/definitions`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`workflowName`	`query`	no
`workflowVersion`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/definitions/export`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/definitions/export-multi`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/definitions/import`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`

`POST /api/workflow/definitions/import-multi`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`GET /api/workflow/definitions/{id}`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`id`	`path`	yes
`includeRendering`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/definitions/{id}/render-graph`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`id`	`path`	yes
`includeSvg`	`query`	no
`version`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/definitions/{name}/activate`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Parameters:

Name	In	Required	Description
`name`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/definitions/{name}/versions`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`name`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/designated-workflows`

List the Designated Workflows recorded by the first-seen ledger.

Returns every workflow the installation has registered in code or stored in the definition store, as the insert-only first-seen ledger records it, and their number: the count the licence monitor evaluates. A workflow stays listed after it is removed from the code catalogue; versions are not counted. On a host without PostgreSQL the ledger is process-memory and holds only what the running process has seen. The licence status and the notice are those of the latest licence evaluation (the status with its factual message; “Licensed to” the licensee, or the message of the notice case), null before the first evaluation. Informational: nothing is refused. Read-only; nothing is sent anywhere.

Property	Value
Operation ID	`GetDesignatedWorkflows`
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`401`	Unauthorized	-
`403`	Forbidden	-

`GET /api/workflow/diagrams/{name}`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`name`	`path`	yes
`layoutEffort`	`query`	no
`layoutOrderingIterations`	`query`	no
`layoutPlacementIterations`	`query`	no
`layoutProvider`	`query`	no
`workflowInstanceId`	`query`	no
`workflowVersion`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/functions`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/instances`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`businessReferenceKey`	`query`	no
`includeDetails`	`query`	no
`status`	`query`	no
`workflowInstanceId`	`query`	no
`workflowName`	`query`	no
`workflowVersion`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/instances/{id}`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`id`	`path`	yes
`actorId`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/metadata`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/retention/run`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/signals/dead-letters`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`includeRawPayload`	`query`	no
`maxMessages`	`query`	no
`signalId`	`query`	no
`signalType`	`query`	no
`workflowInstanceId`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/signals/dead-letters/replay`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/signals/pump/stats`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/signals/raise`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/start`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/supported-formats`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/tasks`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`actorId`	`query`	no
`assignee`	`query`	no
`businessReferenceKey`	`query`	no
`status`	`query`	no
`workflowInstanceId`	`query`	no
`workflowName`	`query`	no
`workflowVersion`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/workflow/tasks/{id}`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`id`	`path`	yes
`actorId`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/tasks/{id}/assign`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/tasks/{id}/complete`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	-

`POST /api/workflow/tasks/{id}/release`

Property	Value
Operation ID	-
Tags	`WorkflowEndpoints`
Auth	Not declared
Request body	`application/json`

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	-

`GET /buildinfo.json`

Image build provenance (module, gitSha, gitCommitTime, imageBuiltAt, branch) for drift detection.

Property	Value
Operation ID	`StellaOpsBuildInfoFile`
Tags	`StellaOps.Workflow.WebService`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-