NextGen APIs

PATCH /work-orders/r1/work-orders/{workOrderId}/operations/{operationId}/materials/{materialId}

Http Verb

PATCH

Url

/work-orders/r1/work-orders/{workOrderId}/operations/{operationId}/materials/{materialId}

Permissions required

Work Order Edit Permission:

fsm.core.workorder.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 updates a material association for a specific work order operation.
The API enforces the following rules before persisting the association. If any check fails, a domain validation error is returned.

  1. Material existence – Verifies the material exists via the materials provider.

  2. Operation & work order loading – Loads the target operation and its parent work order.

  3. Expected quantity – Rejects if the expected quantity is not strictly positive (> 0).

  4. Work order editability::

    1. Reject the change if an accounting send date (AWOOEXTSYSACCOUNTINGSENDDATE) is already present.

    2. Schedulable operation status – If the operation type is schedulable, the allowed status are:
      OPEN, SCHEDULABLE, TO_RESCHEDULE, DRAFT, LOCKED

    3. Admitted materials – Verifies the material is allowed for the work order type by searching admitted materials using:

      1. an exact materialId match, or

      2. a wildcard value -1 (ADMITTED_ALL_MATERIALS).

Path Parameters

Field

Note

workOrderId

Work order identifier that must match the operation.

operationId

Work order operation identifier.

materialId

The material Id

Query String Parameters

None

Header Parameters

Default.

Request Body

Field

Validations

Note

expectedQuantity

Not Null and > 0

Expected quantity for the operation.

note

No

Optional material note.

Response documentation

Response payload fields

No content.

Response error codes

BASE_0001, WORKORDERS_046, WORKORDERS_047,WORKORDERS_048, WORKORDERS_049, WORKORDERS_050, WORKORDERS_051