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

Get all materials

get

/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderMaterial

Request

Path Parameters
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 details about the work order material according to the material identifier of the work order operation.
      Finder Variables:
      • WorkOrderOperationMaterialId; integer; Value that uniquely identifies the work order operation material. It is a primary key that the application generates when it creates the material for the work order operation. This attribute is required.
  • 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; Picked component quantity.
    • AutoTransactFlag; boolean; Contains one of the following values: true or false. If true, the operation is automatically reported, and both resources and materials are automatically charged based on the supply type or the charge type setups. If false, then the operation isn't automatically reported.
    • 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.
    • ContributeToYieldFlag; boolean; Indicates whether this component should contribute to the yield calculation in the manufacturing process. This attribute isn't currently used.
    • CountPointOperationFlag; boolean; Contains one of the following values: true or false. If true, then this operation is a count point operation and you have to manually complete it. If false, then this operation isn't a count point operation.
    • CreatedBy; string; User who created the operation material.
    • CreationDate; string; Date when the user created the operation material.
    • EnforceIntRequirements; string; Value of the enforced integer requirement for the unit of measure of the calculated quantity and inverse quantity of the component. Valid values are Round Up, Round Down, and None.
    • EnforceIntegerRequirementsMeaning; string; Meaning of the enforced integer requirement for the work order component.
    • ExtendedQuantity; number; Adjusted quantity derived after the application of the enforced integer requirement.
    • 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 doesn't 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 issued to 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; Revision of the item.
    • LastUpdateDate; string; Date and time when the user most recently updated the work order operation material.
    • LastUpdatedBy; string; Login of the user who most recently updated the work order operation material.
    • MaterialSequenceNumber; number; Unique sequence of the component 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; Sequence to use when performing the work order operations.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization.
    • PickedQuantity; number; Quantity remaining for allocation.
    • ProducedQuantity; number; Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.
    • RemainingAllocatedQuantity; number; Inverse of the component quantity.
    • 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.
    • StandardOperationCode; string; Abbreviation that identifies the standard operation.
    • StandardOperationId; integer; Value that uniquely identifies the standard operation that the work order references. It is a primary key that the application generates when it creates the standard operation.
    • SubstituteFlag; boolean; Flag used indicate whether the component is a substitute or not. 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 is 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; Reference of 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; Unit of measure for the component quantity.
    • WdOperationMaterialId; integer; Value that uniquely identifies the material of a work order operation. It's the primary key generated by the application when creating the material for the work order operation.
    • WorkAreaId; integer; Value that uniquely identifies the work area. It is a primary key that the application generates when it creates the work area.
    • WorkCenterId; integer; Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center.
    • WorkOrderId; integer; Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
    • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It is 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 is 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 is 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 : workOrders-WorkOrderMaterial
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : workOrders-WorkOrderMaterial-item-response
Type: object
Show Source
  • Title: Allocated Quantity
    Read Only: true
    Picked component quantity.
  • Title: Automatically transact
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, the operation is automatically reported, and both resources and materials are automatically charged based on the supply type or the charge type setups. If false, then the operation isn't automatically reported.
  • 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.
  • Maximum Length: 1
    Indicates whether this component should contribute to the yield calculation in the manufacturing process. This attribute isn't currently used.
  • Title: Count Point
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then this operation is a count point operation and you have to manually complete it. If false, then this operation isn't a count point operation.
  • Read Only: true
    Maximum Length: 64
    User who created the operation material.
  • Read Only: true
    Date when the user created the operation material.
  • Read Only: true
    Maximum Length: 255
    Meaning of the enforced integer requirement for the work order component.
  • Title: Enforce Integer
    Maximum Length: 30
    Value of the enforced integer requirement for the unit of measure of the calculated quantity and inverse quantity of the component. Valid values are Round Up, Round Down, and None.
  • Title: Adjusted Quantity
    Adjusted quantity derived after the application of the enforced integer requirement.
  • 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 doesn't 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: Inverse
    Default Value: 1
    Allocated component quantity.
  • Title: Issued Quantity
    Read Only: true
    Default Value: 0
    Net quantity of the material issued to 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
    Revision of the item.
  • Read Only: true
    Date and time when the user most recently updated the work order operation material.
  • Read Only: true
    Maximum Length: 64
    Login of the user who most recently updated the work order operation material.
  • Links
  • Title: Sequence
    Unique sequence of the component 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
    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 is a primary key of the inventory organization.
  • Title: Picked Quantity
    Read Only: true
    Quantity remaining for allocation.
  • Read Only: true
    Quantity of the assembly that's completed into inventory. The material type for this material is PRIMARY_PRODUCT.
  • Title: Required Quantity
    Read Only: true
    Required component quantity.
  • Title: Quantity per Product
    Default Value: 1
    Quantity required to manufacture each unit of the product.
  • Read Only: true
    Inverse of the component quantity.
  • 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.
  • 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 is a primary key that the application generates when it creates the standard operation.
  • Read Only: true
    Maximum Length: 1
    Flag used indicate whether the component is a substitute or not. This attribute is associated with a feature that requires opt in.
  • 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 is 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
    Reference of 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
    Abbreviation that identifies the unit of measure that the material requirement uses.
  • Title: UOM
    Maximum Length: 3
    Unit of measure for the component quantity.
  • Value that uniquely identifies the material of a work order operation. It's the primary key generated by the application when creating the material for the work order operation.
  • Read Only: true
    Value that uniquely identifies the work area. It is 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 is a primary key that the application generates when it creates the work center.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name of the work center.
  • Read Only: true
    Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
  • Exceptions for Materials
    Title: Exceptions for Materials
    The Exceptions for Materials resource gets the count of exceptions that occurred for materials during the operation.
  • Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation.
  • Attachments for Materials
    Title: Attachments for Materials
    The Attachments for Materials resource manages documents that the user attached to the materials that the work order operation processes.
  • Flexfields for Operation Materials
    Title: Flexfields for Operation Materials
    The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
  • Read Only: true
    Value that uniquely identifies the material for the work order operation. It is a primary key that the application generates when it creates the material for the work order operation.
  • Substitute Materials
    Title: Substitute Materials
    The Substitute Materials resource gets the substitute materials that the work order operation uses.
  • 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 is 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 : Exceptions for Materials
Type: array
Title: Exceptions for Materials
The Exceptions for Materials resource gets the count of exceptions that occurred for materials during the operation.
Show Source
Nested Schema : Attachments for Materials
Type: array
Title: Attachments for Materials
The Attachments for Materials resource manages documents that the user attached to the materials that the work order operation processes.
Show Source
Nested Schema : Flexfields for Operation Materials
Type: array
Title: Flexfields for Operation Materials
The Flexfields for Operation Materials resource manages descriptive flexfields that contain details about the materials that the work order operation processes.
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 : workOrders-WorkOrderMaterial-WorkOrderMaterialExceptionCount-item-response
Type: object
Show Source
Nested Schema : workOrders-WorkOrderMaterial-WorkOrderOperationMaterialAttachment-item-response
Type: object
Show Source
Nested Schema : workOrders-WorkOrderMaterial-WorkOrderOperationMaterialDFF-item-response
Type: object
Show Source
Nested Schema : workOrders-WorkOrderMaterial-WorkOrderOperationSubstituteMaterial-item-response
Type: object
Show Source
  • Read Only: true
    Quantity available to transact for the substitute material
  • Read Only: true
    Maximum Length: 64
    User who created the substitute material.
  • Read Only: true
    Date when the user created the substitute material.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the substitute material
  • Read Only: true
    Maximum Length: 255
    Meaning of the enforced integer requirement for the work order component.
  • Title: Enforce Integer
    Maximum Length: 30
    Value of the enforced integer requirement for the unit of measure of the calculated quantity and inverse quantity of the component. Valid values are Round Up, Round Down, and None.
  • Title: Adjusted Quantity
    The adjusted quantity derived after the application of the enforced integer requirement.
  • 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
  • Title: Organization On-Hand Balance
    Read Only: true
    On hand quantity of the substitute material
  • 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 substitute material quantity. This attribute is associated with a feature that requires opt in.
  • Maximum Length: 1
    Flag 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 is 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 is 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

Examples

This example describes how to get all work order materials.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/WorkOrderId/child/WorkOrderMaterial"

For example, the following command gets all work order materials for work order 300100085483217:

curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/300100085483217/child/WorkOrderMaterial"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "OrganizationId" : 300100075212216,
    "WorkOrderId" : 300100085483217,
    "WorkOrderOperationId" : 300100085483218,
    "OperationSequenceNumber" : 10,
    "OperationName" : "Tablet Assembly",
    "StandardOperationId" : 300100084274237,
    "StandardOperationCode" : "TASSY",
    "WorkAreaId" : 300100081228354,
    "WorkAreaName" : "Tablets",
    "WorkCenterId" : 300100081228362,
    "WorkCenterName" : "Tablet Assembly",
    "WorkOrderOperationMaterialId" : 300100085483229,
    "MaterialSequenceNumber" : 10,
    "MaterialType" : "COMPONENT",
    "InventoryItemId" : 300100075148319,
    "ItemNumber" : "CM4751101",
    "ItemDescription" : "8\" Display w/Capacitive Multi-touch Overlay",
    "ItemRevision" : null,
    "QuantityPERProduct" : 1,
    "BasisType" : "1",
    "Quantity" : 2,
    "InverseQuantity" : 1,
    "UnitOfMeasure" : "Each",
    "RequiredDate" : "2015-12-11T17:09:00-07:00",
    "YieldFactor" : 1,
    "IncludeInPlanningFlag" : true,
    "SupplyType" : "3",
    "SupplyTypeDescription" : "Operation pull",
    "SupplySubinventory" : "Stores",
    "SupplyLocatorId" : null,
    "IssuedQuantity" : 2,
    "ProducedQuantity" : null
  }, {
...
  } ],
...
}
Back to Top