Skip to main content

Workflow Endpoint Catalog

Audience

Developers, frontend engineers, QA, support, security engineers, architects and implementation partners.

Summary

This is the sole authoritative endpoint inventory. It contains 17 verified operations: 15 native Workflow operations and two shared operational operations. Generated Swagger assets and middleware are excluded from the operation count.

“No explicit requirement” means route registration does not require an authenticated principal. “Filtered” means EF Core tenant query filters apply; it does not imply authenticated tenant trust.

Reference Content

The tables below are the authoritative operation inventory for this epic.

Native operations

#MethodRoutePurposeAuthenticationAuthorizationTenant enforcementValidationVerified responseClassificationSource path
1GET/workflow/health-dataReturn Workflow foundation countsNo explicit requirementNoneEntity filters; tenant value may be absentNo request DTO200 anonymous summaryNative/Diagnostic/Foundationmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
2GET/workflow/definitionsList definition summariesNo explicit requirementNoneDefinition filterNo request DTO200 WorkflowDefinitionSummaryDto listNativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
3GET/workflow/definitions/{id:guid}Return full definition graphNo explicit requirementNoneDefinition/version/child filtersGUID route constraint200 WorkflowDefinitionDto; 404 messageNativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
4POST/workflow/definitionsCreate Draft definitionNo explicit requirementNonePositive tenant requiredKey/name/type/domain checks201 WorkflowDefinitionDto; 400/409Nativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
5PUT/workflow/definitions/{id:guid}Update details and optional draft stepsNo explicit requirementNonePositive tenant required plus filtersGUID route; type/domain checks200 WorkflowDefinitionDto; 400/404Nativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
6POST/workflow/definitions/{id:guid}/publishPublish current draftNo explicit requirementNonePositive tenant required plus filtersGUID route; draft/nonempty rules200 WorkflowDefinitionDto; 400/404Nativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
7POST/workflow/instances/startStart latest published versionNo explicit requirementNonePositive tenant requiredDefinition selector and published-version checks201 WorkflowInstanceDto; 400/404Nativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
8GET/workflow/instances/{id:guid}Return instance and tasksNo explicit requirementNoneInstance/task filtersGUID route constraint200 WorkflowInstanceDto; 404 messageNativemicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
9GET/workflow/tasks/myReturn matching Pending caller tasksNo explicit requirementNoneTask/instance filters; identity/roles from contextNo request DTO200 WorkflowTaskDto listNative/Partialmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
10POST/workflow/tasks/{id:guid}/approveApprove Pending taskNo explicit requirementNonePositive tenant required plus filtersGUID; Running/Pending guards200 WorkflowInstanceDto; 404/409Native/Riskmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
11POST/workflow/tasks/{id:guid}/rejectReject task and instanceNo explicit requirementNonePositive tenant required plus filtersGUID; Running/Pending guards200 WorkflowInstanceDto; 404/409Native/Riskmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
12POST/workflow/tasks/{id:guid}/delegateReassign Pending taskNo explicit requirementNonePositive tenant required plus filtersGUID; destination; Running/Pending guards200 WorkflowTaskDto; 400/404/409Native/Riskmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
13GET/workflow/auditReturn recent audit rowsNo explicit requirementNoneAudit filterOptional take clamped 1–1000200 WorkflowAuditLog listNative/Diagnosticmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
14GET/workflow/timelineReturn recent timeline rowsNo explicit requirementNoneTimeline filterOptional take clamped 1–1000200 WorkflowTimeline listNative/Diagnosticmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs
15GET/workflow/outboxReturn selected recent outbox metadataNo explicit requirementNoneNo outbox tenant filterOptional take clamped 1–1000200 anonymous metadata listNative/Diagnostic/Riskmicroservices/src/workflow-service/Api/WorkflowEndpoints.cs

Shared operations

#MethodRoutePurposeAuthenticationAuthorizationTenant enforcementValidationVerified responseClassificationSource path
16GET/Return shared service-information envelopeNo explicit requirementNoneNoneNo request model200 ApiResponse<ServiceInfoResponse>Shared/Foundationmicroservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
17GET/healthRun registered framework health checksNo explicit requirementNoneNoneNo request modelFramework health responseShared/Foundationmicroservices/src/workflow-service/Program.cs

Inventory exclusions

Generated Swagger UI/assets, adjacent-module callback APIs, frontend routes and unverified Gateway patterns are not additional Workflow operations.

Requires Confirmation

Production authentication, authorization, Gateway ownership, diagnostic exposure, OpenAPI publication and future compatibility routes require confirmation.

Source References

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