Skip to main content

Workflow Instance Endpoints

Summary​

Two native operations start a published Workflow and retrieve one instance with tasks. Exact method/route entries are in the endpoint catalog.

Execution API flow​

Start behavior​

The request can select by definition identifier or key and can carry subject, context and initiator data. The latest published version is pinned. No applicable stage causes immediate completion.

Retrieval​

Instance detail returns scalar state and ordered task DTOs. Missing or tenant-invisible instances return not-found.

Requires Confirmation​

Caller permission to start/view instances, source-subject authorization and idempotent start semantics require confirmation.

Source References​

  • microservices/src/workflow-service/Api/WorkflowEndpoints.cs
  • microservices/src/workflow-service/Application/Commands/WorkflowInstanceCommands.cs
  • microservices/src/workflow-service/Application/Queries/WorkflowQueries.cs
  • microservices/src/workflow-service/Application/Dtos.cs

See Also​

Keywords​

Workflow API, approval endpoint, Workflow Service.

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20