1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Process Work Orders
  5. Work Order Materials

Get all materials

get

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderMaterial

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds materials for a process work order.
      Finder Variables:
      • WorkOrderOperationMaterialId; integer; Value that uniquely identifies the material resource for the process work order operation. It's a primary key that the application generates when it creates the resource.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AllocatedQuantity; number; Quantity of the material already allocated.
    • BasisType; string; 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.
    • CreatedBy; string; User who created the process work order input.
    • CreationDate; string; Date when the user created the work order operation input.
    • IncludeInPlanningFlag; boolean; 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.
    • InventoryItemId; integer; Value that uniquely identifies the item, product, or assembly in the inventory organization.
    • IssuedQuantity; number; Net quantity of the material that the application issued for the operation.
    • ItemNumber; string; 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.
    • ItemRevision; string; Value that indicates the revision of the item.
    • LastUpdateDate; string; Date when the user most recently updated the work order operation input.
    • LastUpdatedBy; string; User who updated the process work order input.
    • MaterialSequenceNumber; number; Number that indicates the unique sequence of the material assigned to the work order operation.
    • MaterialType; string; 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.
    • OperationSequenceNumber; number; Number that indicates the sequence to use when performing the work order operations.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
    • PickedQuantity; number; Quantity of the material already picked.
    • ProducedQuantity; number; Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.
    • RemainingAllocatedQuantity; number; Quantity of the material remaining to be allocated.
    • RequiredDate; string; 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.
    • SecondaryUOMCode; string; 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.
    • StandardOperationCode; string; Abbreviation that identifies the standard operation.
    • StandardOperationId; integer; 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.
    • SubstituteFlag; boolean; 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.
    • SupplyLocator; string; Locator in subinventory to use, by default, when the plant draws material during assembly or an operation pull.
    • SupplyLocatorId; integer; Value that uniquely identifies the locator. It's a primary key that the application generates when it creates the locator.
    • SupplySubinventory; string; Subinventory to use, by default, when the plant draws material during assembly or an operation pull.
    • SupplyType; string; 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.
    • UOMCode; string; 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.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
    • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order.
    • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
    • WorkOrderOperationMaterialId; integer; 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.
    • YieldFactor; number; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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-ProcessWorkOrderMaterial
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderMaterial-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-ProcessWorkOrderMaterial-MaterialAttachment-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderMaterial-MaterialDFF-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderMaterial-MaterialExceptionCount-item-response
Type: object
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderMaterial-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