POST /work-orders/permits/r1/required

Business Logic

This API logically insert a required permit
It enforces these rules before insertion. If any check fails, it returns a domain validation error.

1. Field validation checks:

   1. Code not null and max 255 characters

   2. Institute max 255 characters

   3. Description required multi-language values

2. Validates that the work order and optional operation exist and are in valid states.
   Also checks that the work order is not in a bundle.

3. Work order editability – Rejects the request if:

   1. Required permit is blocker AND work order status is not OPEN, RELEASED, LOCKED, PARTIALLY_ACCOUNTED, or TO_RESCHEDULE
      OR

   2. Required permit is not blocker AND work order status is CLOSED, CANCELLED, ALIGNED, or TECHNICALLY_CLOSED

4. If work order operation is assigned, checks if permit is blocker AND work order operation status is not OPEN, SCHEDULABLE, LOCKED, or TO_RESCHEDULE

5. Uniqueness check

Path Parameters

None

Query String Parameters

None

Header Parameters

Default.

Request Body

Response documentation

Response payload fields

Response error codes

BASE_0001, BASE_0003, BASE_0006, BASE_0007, PERMIT_0006, PERMIT_0015, PERMIT_0016, PERMIT_0017, PERMIT_0018, PERMIT_0030