|
Http Verb |
POST |
|---|---|
|
Url |
/workforce/tools/r1/categories |
|
Permissions required |
Tool Edit Configuration Permission:
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2026 W3 (FSM 24.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
|
Business Logic
This API creates a new tool category record.
It enforces these rules before insertion. If any check fails, it returns a domain validation error.
Field validation checks:
-
code is mandatory and unique.
-
If active is not provided, it is defaulted to true.
Path Parameters
None
Query String Parameters
None
Header Parameters
Default.
Request Body
|
Field |
Validations |
Note |
|---|---|---|
|
code |
Not null; unique; maximum 255 characters |
Required tool category code |
|
description |
Not null |
Required tool category description |
|
active |
Boolean |
default true |
|
order |
|
|
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
Identifier of the created tool category |