NextGen APIs

DELETE /work-orders/permits/r1/required/{permitRequiredId}

Http Verb

DELETE

Url

/work-orders/permits/r1/required/{permitRequiredId}

Permissions required

Permits View/Edit Permission:

fsm.core.wopermit.view

fsm.core.wopermit.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 logically deletes a permission by setting deleted = true.
It enforces these rules before deletion. If any check fails, it returns a domain validation error.

  1. Verifies the required permit exists

  2. Checks for a related and not deleted obtained permit

  3. 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.

  4. 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

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

Path Parameters

Field

Note

permitRequiredId

Identifier of the required permit that will be logical removed

Header Parameters

Default.

Response documentation

Response error codes

BASE_0001, NOT_FOUND, PERMIT_0013, PERMIT_0015, PERMIT_0016, PERMIT_0017, PERMIT_0017, PERMIT_0030