Skip to main content

Workflow API Response Models

Summary​

Workflow uses typed DTOs for core resources, anonymous projections for selected diagnostics, persistence entities for audit/timeline, and shared/framework contracts for root health information.

Success patterns​

  • Definition creation and instance start return created results with DTO bodies and resource locations.
  • Other successful commands return standard success results with DTO bodies.
  • Lists return arrays of summary, task, audit, timeline or anonymous outbox metadata objects.
  • Definition/instance detail returns one DTO.
  • Shared service information returns a standard shared envelope.
  • Framework health uses the registered health-check response.

Diagnostic shapes​

Workflow summary contains service/stage/tenant/seeded fields and nested counts. Outbox projection contains selected identifiers, event/status/correlation/source/time fields without payload content.

Contract boundaries​

Audit and timeline expose infrastructure entity shapes rather than dedicated public DTOs. OpenAPI generation can infer schemas, but no checked-in generated contract was inspected.

Requires Confirmation​

Long-term diagnostic contracts, location-header consumers and generated OpenAPI publication require confirmation.

Source References​

  • microservices/src/workflow-service/Api/WorkflowEndpoints.cs
  • microservices/src/workflow-service/Api/EndpointResults.cs
  • microservices/src/workflow-service/Application/Dtos.cs
  • microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs

See Also​

Keywords​

Workflow API, approval endpoint, Workflow Service.

Revision Information​

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