Get one scheduled work order
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/scheduledWorkOrders/{scheduledWorkOrdersUniqID}
Request
Path Parameters
-
PlanId(required): integer(int64)
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=
-
scheduledWorkOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanId and WorkOrderId ---for the Scheduled Work Orders resource and used to uniquely identify an instance of Scheduled Work Orders. The client should not generate the hash key value. Instead, the client should query on the Scheduled Work Orders collection resource with a filter on the primary key values in order to navigate to a specific instance of Scheduled Work Orders.
For example: scheduledWorkOrders?q=PlanId=<value1>;WorkOrderId=<value2>
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
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".
-
REST-Framework-Version: string
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : productionSchedulingPlans-scheduledWorkOrders-item-response
Type:
Show Source
object-
ActualEndDate: string
(date-time)
Read Only:
trueDate and time when the work order operation is no longer effective. -
ActualStartDate: string
(date-time)
Read Only:
trueDate and time when the work order operation is actually effective. -
AggregatedFlowScheduleId: integer
(int64)
Read Only:
trueValue that uniquely identifies the aggregate flow schedule. This attribute is read only. -
AssetDescription: string
Read Only:
trueMaximum Length:240Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. -
AssetId: integer
(int64)
Read Only:
trueValue that uniquely identifies the asset charge. This attribute is read only. -
AssetNumber: string
Read Only:
trueMaximum Length:80Number that uniquely identifies the asset. -
AttributeValues: string
Read Only:
trueMaximum Length:4000Attribute values associated with a work order. -
BuildSequence: number
Read Only:
trueSequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor. -
CompletedQuantity: number
Read Only:
trueQuantity of primary product completed so far in the work order. -
Description: string
Read Only:
trueMaximum Length:500Quantity of primary product completed so far in the work order. -
EarliestStartDate: string
(date-time)
Read Only:
trueDescription of the production schedule. -
FirmPlannedFlag: boolean
Read Only:
trueMaximum Length:1Date when the work order operation can be requested at the earliest. -
InventoryItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the inventory item. -
ItemCode: string
Read Only:
trueMaximum Length:300Abbreviation that identifies the item. -
ItemDescription: string
Read Only:
trueMaximum Length:500Description of the item that's produced by the work order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaintenanceOrganizationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the maintenance organization. -
MaintenanceResourceCode: string
Read Only:
trueMaximum Length:300Abbreviation that identifies the maintenance resource. -
MaintenanceResourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the maintenance resource. It's a primary key of the resource. -
MaintenanceWorkCenterCode: string
Read Only:
trueMaximum Length:100Abbreviation that identifies the maintenance work center. -
MaintenanceWorkCenterId: integer
(int64)
Read Only:
trueValue that uniquely identifies the maintenance work center. It's a primary key of the work center. -
MaterialAvailable: string
Read Only:
trueMaximum Length:30Contains 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
Read Only:
truePlanned start quantity of the work order, after taking into account the cumulative yield factor. -
NettableRemainingQuantity: number
Read Only:
trueRemaining quantity of the work order, after taking into account the completions, scrap, and cumulative yield factor. -
OnHoldFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueMaximum Length:20Class of the work order. Valid values include HotOrder, Committed, and Uncommitted. -
PeggedDemands: string
Read Only:
trueMaximum Length:4000Demands and customers pegged to a work order. -
PlanId: integer
Read Only:
trueValue that uniquely identifies the production schedule. -
PlannedStartQuantity: number
Read Only:
trueQuantity 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
Read Only:
trueQuantity planned to be produced for the work order. -
PrimaryProductRemainingQuantity: number
Read Only:
trueQuantity remaining to be produced for the work order. -
ProductionLineCode: string
Read Only:
trueMaximum Length:30Code that identifies the production line. -
ProductionLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the production line. -
ProductionLineName: string
Read Only:
trueMaximum Length:120Name of the production line. -
ProductionLineRate: number
Read Only:
trueRate at which production should progress per hour on a specific production line. -
RejectedQuantity: number
Read Only:
trueTotal rejected quantity across all operations for the work order. -
RemainingQuantity: number
Read Only:
trueQuantity that's remaining. -
RequestedDate: string
(date-time)
Read Only:
trueDate when the work order operation is requested. -
RescheduledFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueThe total quantity of demands reserved to the work order. -
RoutingCode: string
Read Only:
trueMaximum Length:300Abbreviation that identifies the work definition for this work order. -
ScheduledBuildSequence: number
Read Only:
trueThe scheduled sequence or order of flow schedules based on which manufacturing activity's carried out on the shop floor. -
ScheduledEndDate: string
(date-time)
Read Only:
trueDate when the work order is scheduled to complete. -
ScheduledStartDate: string
(date-time)
Read Only:
trueDate when the work order is scheduled to start. -
ScrappedQuantity: number
Read Only:
trueTotal scrapped quantity across all operations for the work order. -
SelectedForReleaseFlag: boolean
Read Only:
trueMaximum Length:1Contains 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
Read Only:
trueMaximum Length:80Number that uniquely identifies the serial that the asset references. This attributes is applied when the item is serial controlled. -
SupplyPlanSupplyId: integer
(int64)
Read Only:
trueValue that uniquely identifies the supply plan for planned order supplies. -
TargetCompletionDate: string
(date-time)
Read Only:
trueDate when the work order is targeted to be scheduled. This attribute overrides the need-by date of the work order. -
UnitOfMeasure: string
Read Only:
trueMaximum Length:25Name of the unit of measure. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure for the primary product. -
WorkDefinitionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work definition. -
WorkDefinitionVersionNumber: string
Read Only:
trueMaximum Length:10Value that indicates the version of the work definition. -
WorkMethodCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the user key to the work method. -
WorkMethodId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work method for which this work definition is applicable. -
WorkMethodName: string
Read Only:
trueMaximum Length:120Name of the work method. -
WorkOrderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the work order. It's a primary key of the work order. -
WorkOrderNumber: string
Read Only:
trueMaximum Length:300Number that uniquely identifies the work order. -
WorkOrderPriority: number
Read Only:
trueValue that indicates the value of the work order. -
WorkOrderStatus: string
Read Only:
trueMaximum Length:30Value the indicates the status of the work order. -
WorkOrderStatusName: string
Read Only:
trueMaximum Length:120The work order status. -
WorkOrderSubTypeCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the subtype of the work order. -
WorkOrderSubTypeName: string
Read Only:
trueMaximum Length:80Name of the work order subtype. -
WorkOrderType: string
Read Only:
trueMaximum Length:30Type of work order. Valid vales include Production, Maintenance, or EAM work order. -
WorkOrderTypeCode: string
Read Only:
trueMaximum Length:30Abbreviation that identifies the type of the work order. -
WorkOrderTypeName: string
Read Only:
trueMaximum Length:80Name of the work order type.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.