Get all work orders

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrders

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=
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 work orders according to the primary key.
      Finder Variables
      • PlanId; integer; Value that uniquely identifies the production schedule.
      • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key of the work order.
    • RescheduledInReleaseHorizonFinder Find work orders according to the primary key.
      Finder Variables
      • ReleaseHorizonEndDate; string; Find work orders according to the release horizon end date.
  • 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:
    • ActualEndDate; string; Date and time when the work order operation is no longer effective.
    • ActualStartDate; string; Date and time when the work order operation is actually effective.
    • AssetDescription; string; Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset.
    • AssetId; integer; Value that uniquely identifies the asset charge. This attribute is read only.
    • AssetNumber; string; Number that uniquely identifies the asset.
    • CompletedQuantity; number; Quantity of primary product completed so far in the work order.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the user created the record.
    • Description; string; Description of the production schedule.
    • EarliestStartDate; string; Date when the work order operation can be requested at the earliest.
    • FirmPlannedFlag; boolean; Contains one of the following values: true or false. If true, then allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations with respect to the work order. If false, then don't allow Oracle Supply Planning Cloud from suggesting rescheduling and replanning recommendations. This attribute doesn't have a default value.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • ItemCode; string; Abbreviation that identifies the item.
    • ItemDescription; string; Description of the item that's produced by the work order.
    • 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.
    • MaterialAvailable; string; Contains one of the following values: true or false. If true, then all the material is available for a work order. If false, then the material isn't available for a work order. This attribute doesn't have a default value.
    • NettablePlannedQuantity; number; Planned start quantity of the work order, after taking into account the cumulative yield factor.
    • NettableRemainingQuantity; number; Remaining quantity of the work order, after taking into account the completions, scrap, and cumulative yield factor.
    • OnHoldFlag; boolean; Contains one of the following values: true or false. If true, then the work order is on hold. If false, then the work order isn't on hold. This attribute doesn't have a default value.
    • OrderClass; string; Class of the work order. Valid values include HotOrder, Committed, and Uncommitted.
    • PlanId; integer; Value that uniquely identifies the production schedule.
    • PlannedStartQuantity; number; Quantity of planned work order which should be greater than zero for standard work orders, and can be equal to or greater than zero for nonstandard work orders.
    • PrimaryProductQuantity; number; Quantity planned to be produced for the work order.
    • PrimaryProductRemainingQuantity; number; Quantity remaining to be produced for the work order.
    • RejectedQuantity; number; Total rejected quantity across all operations for the work order.
    • RemainingQuantity; number; Quantity that's remaining.
    • RequestedDate; string; Date when the work order operation is requested.
    • RescheduledFlag; boolean; Contains one of the following values: true or false. If true, then work order is rescheduled. If false, then work order isn't rescheduled. This attribute doesn't have a default value.
    • ReservedQuantity; number; The total quantity of demands reserved to the work order.
    • RoutingCode; string; Abbreviation that identifies the work definition for this work order.
    • ScheduledEndDate; string; Date when the work order is scheduled to complete.
    • ScheduledStartDate; string; Date when the work order is scheduled to start.
    • ScrappedQuantity; number; Total scrapped quantity across all operations for the work order.
    • SelectedForReleaseFlag; boolean; Contains one of the following values: true or false. If true, then work order is selected for release. If false, then work order isn't selected for release. This attribute doesn't have a default value.
    • SerialNumber; string; Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled.
    • SupplyPlanSupplyId; integer; Value that uniquely identifies the supply plan for planned order supplies.
    • TargetCompletionDate; string; Date when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order.
    • UOMCode; string; Abbreviation that identifies the unit of measure for the primary product.
    • UnitOfMeasure; string; Name of the unit of measure.
    • WorkDefinitionId; integer; Value that uniquely identifies the work definition.
    • WorkDefinitionVersionNumber; string; Value that indicates the version of the work definition.
    • WorkMethodCode; string; Abbreviation that identifies the user key to the work method.
    • WorkMethodId; integer; Value that uniquely identifies the work method for which this work definition is applicable.
    • WorkMethodName; string; Name of the work method.
    • WorkOrderId; integer; Value that uniquely identifies the work order. It's a primary key of the work order.
    • WorkOrderNumber; string; Number that uniquely identifies the work order.
    • WorkOrderPriority; number; Value that indicates the value of the work order.
    • WorkOrderStatus; string; Value the indicates the status of the work order.
    • WorkOrderStatusName; string; The work order status.
    • WorkOrderSubTypeCode; string; Abbreviation that identifies the subtype of the work order.
    • WorkOrderSubTypeName; string; Name of the work order subtype.
    • WorkOrderType; string; Type of work order. Valid vales include Production, Maintenance, or EAM work order.
    • WorkOrderTypeCode; string; Abbreviation that identifies the type of the work order.
    • WorkOrderTypeName; string; Name of the work order type.
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-item-response
Type: object
Show Source
Nested Schema : Demands
Type: array
Title: Demands
Demands and customers pegged to a work order.
Show Source
Nested Schema : Work Order Operations
Type: array
Title: Work Order Operations
The Operations resource manages the operations that are a part of the work definition.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-demands-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-item-response
Type: object
Show Source
Nested Schema : Operation Materials
Type: array
Title: Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process.
Show Source
Nested Schema : Operation Resources
Type: array
Title: Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation.
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationMaterials-item-response
Type: object
Show Source
Nested Schema : productionSchedulingPlans-workOrders-operations-operationResources-item-response
Type: object
Show Source
Back to Top