|
Http Verb |
POST |
|---|---|
|
Url |
/work-orders/permits/r1/types |
|
Permissions required |
Permits 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 permit type configuration record.
It enforces these rules before insertion. If any check fails, it returns a domain validation error.
Field validation checks:
-
code is mandatory.
-
description must include required multi-language values.
-
Multi-language fields are completed/normalized before persistence.
-
code must be unique among existing permit types.
-
If active is not provided, it is defaulted to true.
-
If blocker is not provided, it is defaulted to false.
When all validations pass, the permit type is inserted and the generated identifier is written to the event journal.
Path Parameters
None
Query String Parameters
None
Header Parameters
Default.
Request Body
|
Field |
Validations |
Note |
|---|---|---|
|
code |
Not null; unique; maximum 255 characters |
Required permit code |
|
description |
Not null; multi-language values |
Required permit description |
|
institute |
Maximum 255 characters |
Institute associated with the required permit |
|
blocker |
Boolean |
Indicates whether the permit blocks the work order or operation default false |
|
active |
Boolean |
default true |
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
Identifier of the created permit type |