1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Production Scheduling Plans
  5. Work Orders
  6. Work Order Operations
  7. Operation Materials

Get all operation materials

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrders/{workOrdersUniqID}/child/operations/{operationsUniqID}/child/operationMaterials

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key--- PlanId, WorkOrderOperationId and ResourceSequenceNumber ---for the Work Order Operations resource and used to uniquely identify an instance of Work Order Operations. The client should not generate the hash key value. Instead, the client should query on the Work Order Operations collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Order Operations.

    For example: operations?q=PlanId=<value1>;WorkOrderOperationId=<value2>;ResourceSequenceNumber=<value3>
  • This is the hash key of the attributes which make up the composite key--- PlanId and WorkOrderId ---for the Work Orders resource and used to uniquely identify an instance of Work Orders. The client should not generate the hash key value. Instead, the client should query on the Work Orders collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Orders.

    For example: workOrders?q=PlanId=<value1>;WorkOrderId=<value2>
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 Find operation materials according to the primary key.
      Finder Variables
      • InventoryItemId; integer; Value that uniquely identifies the inventory item.
      • PlanId; integer; Value that uniquely identifies the production schedule.
      • ResourceSequenceNumber; integer; Number that identifies the resource sequence of operation material.
      • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
  • 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:
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • IssuedQuantity; number; Quantity issued on the operation.
    • ItemCode; string; Abbreviation that identifies the item.
    • LastUpdateDate; string; Date and time when the user most recently updated the record.
    • LastUpdateLogin; string; Login that the user used when updating the document.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MaterialSequenceNumber; number; Number that indicates the sequence for a component item for a work order operation.
    • MaterialType; string; Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item.
    • PlanId; integer; Value that uniquely identifies the production schedule.
    • ProducedQuantity; number; Quantity issued so far, since partial issues are possible.
    • Quantity; number; Quantity of the material either consumed in the operation or produced from the operation.
    • RemainingQuantity; number; Quantity that's remaining.
    • ResourceSequenceNumber; integer; Number that identifies the resource sequence of the operation material.
    • UOMCode; string; Abbreviation that identifies the unit of measure.
    • UnitOfMeasure; string; Name of the unit of measure.
    • WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
    • WorkOrderOperationMaterialId; integer; Value that uniquely identifies the component item for a work order operation.
  • 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 : productionSchedulingPlans-workOrders-operations-operationMaterials
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationMaterials-item-response
Type: object
Show Source
Back to Top