List category suggestions
GET
/api/category-suggestionsAdministratorRead-only
Query parameters
| Name | Type | Required | Notes |
|---|---|---|---|
status | enum CategorySuggestionStatus | Optional | PENDING_REVIEWAPPROVEDMAPPEDREJECTED |
Response
Success: 200
An array of CategorySuggestionView, each with:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
projectId | string (uuid) | Optional | |
changeId | string (uuid) | Optional | |
proposedCode | string | Optional | |
proposedName | string | Optional | |
proposedGroup | enum CategoryGroup | Optional | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
rationale | string | Optional | |
status | enum CategorySuggestionStatus | Optional | PENDING_REVIEWAPPROVEDMAPPEDREJECTED |
resolvedCode | string | Optional | |
deciderName | string | Optional | |
createdAt | string (date-time) | Optional | |
decidedAt | string (date-time) | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | invalid_change_filter | Changes area |
400 | invalid_change_review | Changes area |
400 | invalid_sensitive_paths | Changes area |
404 | change_not_found | Changes area |
404 | duplicate_candidate_not_found | Changes area |
409 | change_processing | Changes area |
409 | change_not_eligible_for_ai | Changes area |
409 | duplicate_candidate_decided | Changes area |
409 | change_excluded | Changes area |
409 | change_in_release | Changes area |
502 | ai_classification_failed | Changes area |
503 | ai_classification_unavailable | Changes area |
404 | category_not_found | Categories area |
404 | category_suggestion_not_found | Categories area |
409 | category_code_taken | Categories area |
409 | category_system | Categories area |
409 | category_suggestion_decided | Categories area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/category-suggestions" \
-b cookies.txt -c cookies.txt
Response
200Example
[
{
"id": "<uuid>",
"projectId": "<uuid>",
"changeId": "<uuid>",
"proposedCode": "<string>",
"proposedName": "<string>",
"proposedGroup": "FEATURE",
"rationale": "<string>",
"status": "PENDING_REVIEW",
"resolvedCode": "<string>",
"deciderName": "<string>",
"createdAt": "<date-time>",
"decidedAt": "<date-time>"
}
]