NextGen APIs

POST /work-orders/r1/work-orders/{workOrderId}/cancellations

Http Verb

POST

Url

/work-orders/r1/work-orders/{workOrderId}/cancellations

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W1 (FSM 16.0)

Deprecated since


Removed since


Tech Tags


Business Logic

This API set CANCELLED status on a Work Order.

To successfully call the API, the work order must be in OPEN, RELEASED, LOCKED, PROPOSAL , TO_RESCHEDULE, PARTIALLY_ACCOUNTED, IN_CHARGE, SUBMITTED, PLANNED, DRAFT status.

All the operations related to the work order will change their status to CANCELLED.

Header Parameters

Default.

Path Parameters

Field

Note

workOrderId


Request Body Parameters

Field

Validations

Note

cancelReasonId

 

Allowed values: 1 which corresponds to ACTION_BY_EXTERNAL_SYSTEM_REQUEST used as default and 2 which corresponds to MANUAL_ACTION

Response error codes

NOT_FOUND, C270_1328, ODL010, C270_0206, ODL008, ODL007, ODL006, ODL005, ODL017