Helpdesk Endpoint Catalog
Audience
Developers, QA, security, support, architects and implementation partners.
Summary
This is the sole authoritative endpoint inventory. It contains 39 verified operations: 30 canonical, five compatibility, two shared operational and two Helpdesk-specific employee gateway operations. Reverse-proxy route patterns and the broader employee composite dashboard are described as boundaries, not counted as additional Helpdesk operations.
Reference Content
“No explicit requirement” means the reviewed startup and route registration do not require an authenticated principal. Tenant query filtering is documented independently from authentication and authorization.
Canonical operations
| Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|
| GET | /helpdesk/health-data | Return tenant-visible foundation counts | No explicit requirement | None | EF query filters; missing context scopes to tenant 0 | No request model | 200 anonymous health-data object | Native/Diagnostic | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/tickets | List tenant-visible tickets | No explicit requirement | None | Ticket global filter; missing context scopes to tenant 0 | No server filter/paging input | 200 TicketDto list | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/tickets/{id:guid} | Return ticket detail and children | No explicit requirement | None | Ticket/children global filters | GUID route constraint | 200 TicketDetailDto; 404 message object | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets | Create ticket and lifecycle event | No explicit requirement | None | Positive tenant required; referenced rows tenant-filtered | Category/priority existence; title value object | 201 TicketDto; 400 validation/tenant; 404 reference | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/assign | Set current assignee and append history | No explicit requirement | None | Ticket global filter | GUID route; no positive-assignee validation | 200 TicketDto; 404 message object | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/comments | Append ticket comment | No explicit requirement | None | Ticket global filter | GUID route; required body | 201 CommentDto; 400 validation; 404 message | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/status | Set any parseable ticket status | No explicit requirement | None | Ticket global filter | GUID route; status enum parsing | 200 TicketDto; 400 unsupported status; 404 | Native/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/resolve | Set Resolved and complete open SLA rows | No explicit requirement | None | Ticket/SLA global filters | GUID route; optional resolution text | 200 TicketDto; 404 message object | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/close | Set Closed and complete open SLA rows | No explicit requirement | None | Ticket/SLA global filters | GUID route; optional note | 200 TicketDto; 404 message object | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/reopen | Set Reopened and clear closure time | No explicit requirement | None | Ticket global filter | GUID route; optional reason | 200 TicketDto; 404 message object | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/attachments | Upload attachment and create metadata/event | No explicit requirement | None | Ticket global filter; context forwarded downstream | Multipart, nonempty file, maximum 25,000,000 bytes | 201 AttachmentDto; 400; 404; 503 problem | Native/Integration | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/tickets/{id:guid}/attachments | List ticket attachments | No explicit requirement | None | Ticket/attachment global filters | GUID route | 200 AttachmentDto list; 404 message | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/tickets/{id:guid}/attachments/{attachmentId:guid}/download | Download stored attachment bytes | No explicit requirement | None | Attachment global filter; context forwarded downstream | Two GUID route constraints | 200 file; 404 message; 503 problem | Native/Integration | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| DELETE | /helpdesk/tickets/{id:guid}/attachments/{attachmentId:guid} | Delete local attachment reference | No explicit requirement | None | Attachment global filter | Two GUID route constraints | 204; 404 message object | Native/Partial | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/sla-breach | Create breached SLA record and event | No explicit requirement | None | Ticket/policy global filters | GUID route; active matching policy required | 200 anonymous SLA object; 400; 404 | Native/Diagnostic | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/tickets/{id:guid}/escalate | Create sent escalation and event | No explicit requirement | None | Ticket global filter | GUID route; required reason; level defaults to 1 | 200 anonymous escalation object; 400; 404 | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/sla/check | Mark due assigned active SLA rows breached/escalated | No explicit requirement | None | SLA/ticket/escalation global filters | Optional as-of timestamp | 200 SlaCheckResultDto | Native/Operational | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/categories | List tenant-visible categories | No explicit requirement | None | Category global filter; missing context scopes to tenant 0 | No request model | 200 CategoryDto list | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/categories | Create category | No explicit requirement | None | Positive tenant required | Required name; persistence constraints | 201 CategoryDto; 400 validation/tenant | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/priorities | List tenant-visible priorities | No explicit requirement | None | Priority global filter; missing context scopes to tenant 0 | No request model | 200 PriorityDto list | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/priorities | Create priority | No explicit requirement | None | Positive tenant required | Required name; level defaults; rank minimum defaults | 201 PriorityDto; 400 validation/tenant | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/sla-policies | List tenant-visible SLA policies | No explicit requirement | None | Policy global filter; missing context scopes to tenant 0 | No request model | 200 SlaPolicyDto list | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /helpdesk/sla-policies | Create SLA policy | No explicit requirement | None | Positive tenant required | Required name; target default; duration value object | 201 SlaPolicyDto; 400 validation/tenant | Native | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/audit | Read recent tenant audit rows | No explicit requirement | None | Audit global filter | Optional take clamped 1–1000 | 200 audit entity list | Native/Diagnostic | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/timeline | Read recent tenant timeline rows | No explicit requirement | None | Timeline global filter | Optional take clamped 1–1000 | 200 timeline entity list | Native/Diagnostic | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/outbox | Read recent outbox rows | No explicit requirement | None | No tenant query filter on outbox | Optional take clamped 1–1000 | 200 outbox entity list | Native/Diagnostic/Risk | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/reports/dashboard | Return ticket/SLA summary | No explicit requirement | None | Underlying entity global filters | No request model | 200 DashboardReportDto | Native/Report | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/reports/sla | Return per-SLA report rows | No explicit requirement | None | Underlying entity global filters | No request model | 200 SlaReportDto list | Native/Report | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/reports/agent-load | Return ticket counts by assignee | No explicit requirement | None | Ticket global filter | No request model | 200 AgentLoadReportDto list | Native/Report | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /helpdesk/reports/category-summary | Return ticket counts by category | No explicit requirement | None | Ticket/category global filters | No request model | 200 CategorySummaryReportDto list | Native/Report | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
Compatibility operations
| Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|
| GET | /api/hr-suite/helpdesk/records | List filtered legacy-shaped records | No explicit requirement | None | Canonical entity filters | Optional status/date/search; invalid status gives 400 | 200 CompatRecordDto list capped at 500; 400 | Compatibility/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| GET | /api/hr-suite/helpdesk/records/{id:int} | Return legacy-shaped record | No explicit requirement | None | Canonical entity filters | Integer route constraint | 200 CompatRecordDto; bare 404 | Compatibility/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| POST | /api/hr-suite/helpdesk/records | Create canonical ticket from legacy shape | No explicit requirement | None | Positive tenant required | Title required; permissive status/priority defaults | 200 CompatRecordDto; 400 | Compatibility/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| PUT | /api/hr-suite/helpdesk/records/{id:int} | Replace mapped compatibility fields | No explicit requirement | None | Canonical entity filters | Integer route; title value object; permissive defaults | 200 CompatRecordDto; 400; bare 404 | Compatibility/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
| PATCH | /api/hr-suite/helpdesk/records/{id:int}/status | Change status through legacy shape | No explicit requirement | None | Canonical entity filters | Integer route; strict status enum parsing | 200 CompatRecordDto; 400; bare 404 | Compatibility/Transitional | microservices/src/helpdesk-service/Api/HelpdeskEndpoints.cs |
Shared operations
| Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|
| GET | / | Return shared service identity envelope | No explicit requirement | None | None | No request model | 200 ApiResponse<ServiceInfoResponse> | Shared/Foundation | microservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.cs |
| GET | /health | Run framework health checks | No explicit requirement | None | None | No request model | Framework health response | Shared/Foundation | microservices/src/helpdesk-service/Program.cs |
Gateway operations
| Method | Route | Purpose | Authentication | Authorization | Tenant enforcement | Validation | Verified response | Classification | Source path |
|---|---|---|---|---|---|---|---|---|---|
| GET | /ess/helpdesk | Forward employee ticket listing | No explicit requirement in reviewed gateway | None | Context forwarded; no requester predicate added | No Helpdesk-specific query validation | Downstream response or gateway aggregate failure | Gateway/Transitional | microservices/src/gateway-api/EssEndpoints.cs |
| POST | /ess/helpdesk | Forward employee ticket creation body | No explicit requirement in reviewed gateway | None | Context forwarded downstream | Body required by gateway; body not transformed | Downstream response or gateway aggregate failure | Gateway/Transitional | microservices/src/gateway-api/EssEndpoints.cs |
Inventory exclusions
Generated Swagger UI/assets, reverse-proxy wildcard patterns, downstream Document/Notification APIs and the broader employee dashboard operation are outside the authoritative Helpdesk operation count.
Requires confirmation
Production authentication, authorization, gateway route ownership, whether diagnostic operations remain public, OpenAPI publication and compatibility retirement require confirmation.
Source References
microservices/src/helpdesk-service/Api/HelpdeskEndpoints.csmicroservices/src/helpdesk-service/Program.csmicroservices/src/shared-kernel/Extensions/EndpointRouteBuilderExtensions.csmicroservices/src/gateway-api/EssEndpoints.cs
Related Articles
See Also
Keywords
Helpdesk endpoint catalog, canonical API, compatibility API, employee gateway.
Revision Information
- Status: Draft
- Last reviewed: 2026-07-20
- Next review: 2026-10-20