|
Http Verb |
PATCH |
|---|---|
|
Url |
/workforce/tools/r1/tools/{toolId} |
|
Permissions required |
Tool Edit 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 updates an existing tool record.
It enforces these rules before update. If any check fails, it returns a domain validation error.
Field validation checks:
-
code is mandatory.
-
active is mandatory.
-
code must be unique among existing tools, excluding the same tool being updated (same id).
Path Parameters
|
Field |
Note |
|---|---|
|
toolId |
The tool Id to update |
Query String Parameters
None
Header Parameters
Default.
Request Body
|
Field |
Validations |
Note |
|---|---|---|
|
code |
Optional |
|
|
description |
Optional |
|
|
typeId |
Optional |
|
|
categoryId |
|
|
|
startDate |
|
|
|
endDate |
|
|
|
active |
|
|
Response documentation
Response payload fields
No content.
Response error codes