Create category
POST
/api/categoriesAdministrator
Request body
application/json
| Field | Type | Required | Notes |
|---|---|---|---|
displayName | string | Required | max 120 |
group | enum CategoryGroup | Required | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
code | string | Required | max CategoryRef.MAX_CODE_LENGTH · pattern [A-Z][A-Z0-9_]* |
Response
Success: 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
code | string | Optional | |
displayName | string | Optional | |
group | enum CategoryGroup | Optional | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
systemCategory | boolean | Optional | |
active | boolean | Optional | |
createdAt | string (date-time) | Optional | |
updatedAt | string (date-time) | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | malformed_requestthe body cannot be read | 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).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/categories" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"displayName": "<string>",
"group": "FEATURE",
"code": "<string>"
}'
The request body is an example built from the schema; replace every placeholder.
Response
201Example
{
"id": "<uuid>",
"code": "<string>",
"displayName": "<string>",
"group": "FEATURE",
"systemCategory": false,
"active": false,
"createdAt": "<date-time>",
"updatedAt": "<date-time>"
}