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
| # | Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | GET | /workflow/health-data | Return Workflow foundation counts | No explicit requirement | None | Entity filters; tenant value may be absent | No request DTO | 200 anonymous summary | Native/Diagnostic/Foundation | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 2 | GET | /workflow/definitions | List definition summaries | No explicit requirement | None | Definition filter | No request DTO | 200 WorkflowDefinitionSummaryDto list | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 3 | GET | /workflow/definitions/{id:guid} | Return full definition graph | No explicit requirement | None | Definition/version/child filters | GUID route constraint | 200 WorkflowDefinitionDto; 404 message | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 4 | POST | /workflow/definitions | Create Draft definition | No explicit requirement | None | Positive tenant required | Key/name/type/domain checks | 201 WorkflowDefinitionDto; 400/409 | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 5 | PUT | /workflow/definitions/{id:guid} | Update details and optional draft steps | No explicit requirement | None | Positive tenant required plus filters | GUID route; type/domain checks | 200 WorkflowDefinitionDto; 400/404 | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 6 | POST | /workflow/definitions/{id:guid}/publish | Publish current draft | No explicit requirement | None | Positive tenant required plus filters | GUID route; draft/nonempty rules | 200 WorkflowDefinitionDto; 400/404 | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 7 | POST | /workflow/instances/start | Start latest published version | No explicit requirement | None | Positive tenant required | Definition selector and published-version checks | 201 WorkflowInstanceDto; 400/404 | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 8 | GET | /workflow/instances/{id:guid} | Return instance and tasks | No explicit requirement | None | Instance/task filters | GUID route constraint | 200 WorkflowInstanceDto; 404 message | Native | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 9 | GET | /workflow/tasks/my | Return matching Pending caller tasks | No explicit requirement | None | Task/instance filters; identity/roles from context | No request DTO | 200 WorkflowTaskDto list | Native/Partial | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 10 | POST | /workflow/tasks/{id:guid}/approve | Approve Pending task | No explicit requirement | None | Positive tenant required plus filters | GUID; Running/Pending guards | 200 WorkflowInstanceDto; 404/409 | Native/Risk | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 11 | POST | /workflow/tasks/{id:guid}/reject | Reject task and instance | No explicit requirement | None | Positive tenant required plus filters | GUID; Running/Pending guards | 200 WorkflowInstanceDto; 404/409 | Native/Risk | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 12 | POST | /workflow/tasks/{id:guid}/delegate | Reassign Pending task | No explicit requirement | None | Positive tenant required plus filters | GUID; destination; Running/Pending guards | 200 WorkflowTaskDto; 400/404/409 | Native/Risk | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 13 | GET | /workflow/audit | Return recent audit rows | No explicit requirement | None | Audit filter | Optional take clamped 1–1000 | 200 WorkflowAuditLog list | Native/Diagnostic | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 14 | GET | /workflow/timeline | Return recent timeline rows | No explicit requirement | None | Timeline filter | Optional take clamped 1–1000 | 200 WorkflowTimeline list | Native/Diagnostic | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
| 15 | GET | /workflow/outbox | Return selected recent outbox metadata | No explicit requirement | None | No outbox tenant filter | Optional take clamped 1–1000 | 200 anonymous metadata list | Native/Diagnostic/Risk | microservices/src/workflow-service/Api/WorkflowEndpoints.cs |
Shared operations
| # | Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|---|
| 16 | GET | / | Return shared service-information envelope | No explicit requirement | None | None | No request model | 200 ApiResponse<ServiceInfoResponse> | Shared/Foundation | microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs |
| 17 | GET | /health | Run registered framework health checks | No explicit requirement | None | None | No request model | Framework health response | Shared/Foundation | microservices/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.csmicroservices/src/workflow-service/Program.csmicroservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs
Related Articles
See Also
Keywords
Workflow API, approval endpoint, Workflow Service.
Revision Information
- Status: Draft
- Last reviewed: 2026-07-20
- Next review: 2026-10-20