NextGen APIs

PATCH /work-orders/permits/r1/types/{typeId}/outcome-reasons/{permitTypeOutcomeReasonId}

Http Verb

PATCH

Url

/work-orders/permits/r1/types/{typeId}/outcome-reasons/{permitTypeOutcomeReasonId}

Permissions required

Permission:

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 update a permit type outcome reason
It enforces these rules before update. If any check fails, it returns a domain validation error.

  1. Field validation checks:

    1. Permit type not null

    2. Outcome reason not null

  2. Validates that the relation associated exists

Path Parameters

Field

Note

typeId

The permit type id

permitTypeOutcomeReasonId

The permit type outcome reason Id to update

Query String Parameters

None

Header Parameters

Default.

Request Body

Field

Validations

Note

outcomeReason

Optional

 

Response documentation

Response payload fields

No content.

Response error codes

BASE_0001, BASE_0003, BASE_0006, PERMIT_0027