NextGen APIs

POST /workforce/tools/r1/types

Http Verb

POST

Url

/workforce/tools/r1/types

Permissions required

Tool Edit Configuration Permission:

fsm.core.tool.configuration.edit

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 type record.
It enforces these rules before insertion. If any check fails, it returns a domain validation error.
Field validation checks:

  1. code is mandatory and unique.

  2. 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 type code

description

Not null

Required tool type description

active

Boolean

default true

order



Response documentation

Response payload fields

Field

Note

id

Identifier of the created tool type

Response error codes

BASE_0001, BASE_0010