NextGen APIs

GET /work-orders/permits/r1/required

Http Verb

GET

Url

/work-orders/permits/r1/required

Permissions required

 Permits View Permission:

fsm.core.wopermit.view

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

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of required permits filtered by input criteria.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id

 

Collection of Ids

code

 

Collection of Strings

description

 

 

typeId


Collection of type ids

workOrderId


Collection of work order ids

workOrderOperationId


Collection of work order operation ids

institute



blocker



deleted



Order ℹ️

Default Order

default

Possible order values

No other ordering options available.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id

 

code

 

description

 

typeId


workOrderId


workOrderOperationId


institute


blocker


deleted


Response error codes

BASE_0001