Skip to main content

Workflow Definition Endpoints

Summary

Four native operations support definition summary listing, full graph retrieval, creation and update. Their exact method/route entries appear only in the endpoint catalog.

List and detail

Listing returns key-ordered summary DTOs. Detail loading returns versions with steps and conditions or a message-shaped not-found result.

Creation

The request includes definition fields and a step list. Commands require tenant, key and name, reject duplicate tenant/key combinations, parse approver types and construct Draft version 1. Success returns a created result with the full definition DTO.

Update

Update accepts optional descriptive fields and an optional step list. Supplying steps replaces the current editable draft; if necessary the aggregate creates the next draft after a published version. Success returns the reloaded full DTO.

Security and tenancy

No authentication or authorization is required by route registration. Mutation commands require tenant context; reads rely on EF query filters.

Requires Confirmation

Backend authoring permissions, update concurrency and full OpenAPI response metadata require confirmation.

Source References

  • microservices/src/workflow-service/Api/WorkflowEndpoints.cs
  • microservices/src/workflow-service/Application/Commands/WorkflowDefinitionCommands.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