Update one material

patch

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{OperationUniqID}/child/Material/{WorkOrderOperationMaterialId}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Operations resource and used to uniquely identify an instance of Operations. The client should not generate the hash key value. Instead, the client should query on the Operations collection resource in order to navigate to a specific instance of Operations to get the hash key.
  • Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.
  • This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Basis
    Maximum Length: 30
    Value that indicates whether the material quantity is fixed; for example, quantity per lot produced, or variable; for example, quantity per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Title: Include in planning
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans supply. The default value is true.
  • Material Attachments
    Title: Material Attachments
    The Material Attachments resource manages the attachments for input material.
  • Flexfields for Materials
    Title: Flexfields for Materials
    The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
  • Exception Counts
    Title: Exception Counts
    The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
  • Title: Required Quantity
    Quantity of the required material.
  • Title: Required Date
    Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.
  • Substitute Materials
    Title: Substitute Materials
    The Substitute Materials resource gets the substitute materials that the work order operation uses.
  • Maximum Length: 255
    Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.
  • Title: Supply Locator
    Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
  • Title: Supply Subinventory
    Maximum Length: 20
    Subinventory to use, by default, when the plant draws material during assembly or an operation pull.
  • Title: Supply Type
    Maximum Length: 30
    Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.
  • Title: Item Yield
    Default Value: 1
    Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Material Attachments
Type: array
Title: Material Attachments
The Material Attachments resource manages the attachments for input material.
Show Source
Nested Schema : Flexfields for Materials
Type: array
Title: Flexfields for Materials
The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
Show Source
Nested Schema : Exception Counts
Type: array
Title: Exception Counts
The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
Show Source
Nested Schema : Substitute Materials
Type: array
Title: Substitute Materials
The Substitute Materials resource gets the substitute materials that the work order operation uses.
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialAttachment-item-patch-request
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialDFF-item-patch-request
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialExceptionCount-item-patch-request
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-SubstituteMaterial-item-patch-request
Type: object
Show Source
  • Title: Inverse
    Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.
  • Title: Priority
    Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.
  • Title: Quantity per Product
    Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.
  • Title: Required Quantity
    Required quantity of the substitute material.
  • Maximum Length: 1
    Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.
  • Title: Primary UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : processWorkOrders-Operation-Material-item-response
Type: object
Show Source
  • Title: Allocated Quantity
    Read Only: true
    Quantity of the material already allocated.
  • Title: Basis
    Maximum Length: 30
    Value that indicates whether the material quantity is fixed; for example, quantity per lot produced, or variable; for example, quantity per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Read Only: true
    Maximum Length: 64
    User who created the process work order input.
  • Read Only: true
    Date when the user created the work order operation input.
  • Title: Include in planning
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then planning considers the material when it plans the supply. If false, then planning does not consider the material when it plans supply. The default value is true.
  • Value that uniquely identifies the item, product, or assembly in the inventory organization.
  • Title: Issued Quantity
    Read Only: true
    Default Value: 0
    Net quantity of the material that the application issued for the operation.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item.
  • Maximum Length: 300
    Number that identifies the item. If the material type is COMPONENT, then ItemNumber references the component to issue to the work order. If the material type is PRIMARY_PRODUCT, then ItemNumber references the assembly that's an output of the work order.
  • Read Only: true
    Maximum Length: 18
    Value that indicates the revision of the item.
  • Read Only: true
    Date when the user most recently updated the work order operation input.
  • Read Only: true
    Maximum Length: 64
    User who updated the process work order input.
  • Links
  • Material Attachments
    Title: Material Attachments
    The Material Attachments resource manages the attachments for input material.
  • Flexfields for Materials
    Title: Flexfields for Materials
    The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
  • Exception Counts
    Title: Exception Counts
    The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
  • Title: Sequence
    Number that indicates the unique sequence of the material assigned to the work order operation.
  • Read Only: true
    Maximum Length: 30
    Default Value: COMPONENT
    Type of material either produced or consumed by the operation. For materials being consumed, a list of accepted values is defined in the lookup type ORA_WIS_WD_INPUT_MATERIAL. For materials being produced, a list of accepted values is defined in the lookup type ORA_WIS_WD_OUTPUT_MATERIAL.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the operation that processes the material.
  • Title: Operation Sequence
    Read Only: true
    Number that indicates the sequence to use when performing the work order operations.
  • Read Only: true
    Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
  • Title: Picked Quantity
    Read Only: true
    Quantity of the material already picked.
  • Read Only: true
    Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.
  • Title: Required Quantity
    Quantity of the required material.
  • Read Only: true
    Quantity of the material remaining to be allocated.
  • Title: Required Date
    Date when the plant requires the materials so that it perform the operation. The required date must not occur before the operation start date, or after the operation completion date.
  • Title: Reserved Quantity
    Read Only: true
    Material quantity that's reserved against the work order operation.
  • Read Only: true
    Required material quantity in the secondary unit of measure. This attribute is read-only. This attribute is associated with a feature that requires opt in.
  • Title: Secondary Unit of Measure
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the secondary unit of measure of the material. This attribute is read-only. This attribute is associated with a feature that requires opt in.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the standard operation.
  • Read Only: true
    Value that uniquely identifies the standard operation that the work order references. It's a primary key that the application generates when it creates the standard operation.
  • Read Only: true
    Maximum Length: 1
    Indicates whether the component is a substitute. This attribute does not have a default value. This attribute is associated with a feature that requires opt in.
  • Substitute Materials
    Title: Substitute Materials
    The Substitute Materials resource gets the substitute materials that the work order operation uses.
  • Maximum Length: 255
    Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.
  • Title: Supply Locator
    Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
  • Title: Supply Subinventory
    Maximum Length: 20
    Subinventory to use, by default, when the plant draws material during assembly or an operation pull.
  • Title: Supply Type
    Maximum Length: 30
    Value that indicates the supply type used for the work order operation material. A list of accepted values is defined in the lookup types EGP_WIP_SUP_TYPE and ORA_WIE_WO_SUPPLY_TYPE.
  • Read Only: true
    Maximum Length: 80
    Description of the supply type.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure for the material quantity and can be the item's primary UOM or a UOM that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM. This enhanced behavior is associated with a feature that requires opt in.
  • Title: UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the material quantity and can be the item's primary UOM code or a UOM code that can be converted. If the item is enabled with primary and secondary tracking unit of measure, the value can be the item's secondary UOM code. This enhanced behavior is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Read Only: true
    Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the work center.
  • Read Only: true
    Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
  • Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
  • Read Only: true
    Value that uniquely identifies the material for the work order operation. It's a primary key that the application generates when it creates the material for the work order operation.
  • Title: Item Yield
    Default Value: 1
    Factor to use when calculating the quantity that the operation requires to accommodate component waste when it processes the item. It's recommended that you set the yield to between 0 and 1. You can set the yield to a value that's greater than 1. The application considers the yield when it calculates the required quantity according to the Include plant parameter for the component yield.
Nested Schema : Material Attachments
Type: array
Title: Material Attachments
The Material Attachments resource manages the attachments for input material.
Show Source
Nested Schema : Flexfields for Materials
Type: array
Title: Flexfields for Materials
The Flexfields for Materials resource manages descriptive flexfields that contain details about the input materials that the work order operation processes.
Show Source
Nested Schema : Exception Counts
Type: array
Title: Exception Counts
The Exception Counts resource gets the count of exceptions that occurred for input materials during the operation.
Show Source
Nested Schema : Substitute Materials
Type: array
Title: Substitute Materials
The Substitute Materials resource gets the substitute materials that the work order operation uses.
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialAttachment-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialDFF-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-MaterialExceptionCount-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-Operation-Material-SubstituteMaterial-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the substitute material.
  • Read Only: true
    Date when the user created the substitute material.
  • Read Only: true
    Value that uniquely identifies the item, product, or assembly in the inventory organization. This attribute is associated with a feature that requires opt in.
  • Title: Inverse
    Inverse of the Quantity Per Product attribute. The application uses the inverse when the Quantity Per Product for the material is a fraction but the inverse of this quantity is an integer. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the item, which is an output of the work order. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Date and time when the user most recently updated the substitute material.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the substitute material.
  • Links
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the inventory organization that's enabled for manufacturing. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. This attribute is associated with a feature that requires opt in.
  • Title: Priority
    Ranking of the substitute component to use instead of the primary component. This attribute is associated with a feature that requires opt in.
  • Title: Quantity per Product
    Quantity required to manufacture each unit of the substitute material. This attribute is associated with a feature that requires opt in.
  • Title: Required Quantity
    Required quantity of the substitute material.
  • Maximum Length: 1
    Mark used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Maximum Length: 255
    Primary unit of measure for the substitute material quantity. This attribute is associated with a feature that requires opt in.
  • Title: Primary UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the substitute material uses. This attribute is associated with a feature that requires opt in.
  • Read Only: true
    Value that uniquely identifies the material for a work order operation. It's a primary key that the application generates when it consumes the material. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the substitute material for a work order operation. It's a primary key that the application generates when it consumes the substitute material. This attribute is associated with a feature that requires opt in.
Back to Top