Get all operations
get
/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrderOperations
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=
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 -
finder: string
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 operations according to the primary key.
Finder Variables- PlanId; integer; Value that uniquely identifies the production schedule.
- ResourceSequenceNumber; integer; Number that identifies the resource sequence of operation.
- WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
- PrimaryKey Find operations according to the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
- ChangedByLastRepairFlag; boolean; Contains one of the following values: true or false. If true, then object is changed by last repair solve. If false, then object isn't changed by last repair solve. This attribute doesn't have a default value.
- ChangedSinceLastSolveFlag; boolean; Contains one of the following values: true or false. If true, then object is changed by last solve. If false, then object isn't changed by last solve. This attribute doesn't have a default value.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- DurationResourceCode; string; Abbreviation that identifies the resource for the duration resource in an operation.
- DurationResourceId; integer; Value that uniquely identifies the duration production resource which is the principal resource.
- DurationResourceSetCode; string; Abbreviation that identifies the resource set of the duration resource.
- EndDate; string; Date and time when the work order operation is no longer effective.
- ExecutionSequence; number; Execution sequence of the work order operation.
- FirmStatus; string; Status of the operation firm. Valid values include Firm Start, Firm End, and Firm Range. The operation isn't firmed if this isn't specified.
- InventoryShortagePeggedFlag; boolean; Contains one of the following values: true or false. If true, then the operation has a material shortage. If false, then the operation doesn't have a material shortage. This attribute doesn't have a default value.
- 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.
- LotMultipleResourceCode; string; Abbreviation that identifies the resource that's the lot multiple resource.
- LotMultipleResourceId; integer; Value that uniquely identifies the production resource that's the lot multiple resource.
- LotMultipleResourceSetCode; string; Abbreviation that identifies the resource set with the lot multiple resource.
- OperationCode; string; Abbreviation that identifies the operation.
- OperationName; string; Name of the operation.
- OperationSequenceNumber; number; Number that identifies the execution sequence of the operation.
- OperationType; string; Type of the resource operation, which indicates if it's an in house or and outside supplier operation.
- PlanId; integer; Value that uniquely identifies the production schedule.
- ResourceSequenceNumber; integer; Number that identifies the resource sequence of the operation.
- ScheduledDuration; number; Duration of schedule of the operation.
- ScheduledDurationUnit; string; Time unit of measure for the schedule duration of the operation. Valid values include second, minutes, hours, and days.
- ScheduledEndDate; string; Date when the work order operation schedule ends.
- ScheduledStartDate; string; Date when the work order operation is scheduled.
- StartDate; string; Date and time when the work order operation is effective.
- Status; string; Status of the operation. Valid values include Open, Active, or Closed.
- SupplierId; integer; Value that uniquely identifies the supplier for the operation.
- SupplierName; string; Name of the supplier associated with the operation.
- SupplierSiteCode; string; Abbreviation that identifies the supplier associated with the operation.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site for the operation.
- SupplyReservationsFlag; boolean; Contains one of the following values: true or false. If true, then the work order contains supply reservations. If false, then work order doesn't contain a supply reservation. The default value is false.
- WorkCenterId; integer; Value that uniquely identifies the work center. It's a primary key of the work center.
- WorkDefinitionOperationId; integer; Value that uniquely identifies the work definition operation.
- 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.
- WorkOrderOperationId; integer; Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
- Yield; number; Yield percent of the work order operation.
-
totalResults: boolean
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
-
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.
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-workOrderOperations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-item-response
Type:
Show Source
object
-
ActualEndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ActualStartDate: string
(date-time)
Date and time when the work order operation is actually effective.
-
ChangedByLastRepairFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last repair solve. If false, then object isn't changed by last repair solve. This attribute doesn't have a default value. -
ChangedSinceLastSolveFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then object is changed by last solve. If false, then object isn't changed by last solve. This attribute doesn't have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DurationResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource for the duration resource in an operation. -
DurationResourceId: integer
(int64)
Value that uniquely identifies the duration production resource which is the principal resource.
-
DurationResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set of the duration resource. -
EndDate: string
(date-time)
Date and time when the work order operation is no longer effective.
-
ExecutionSequence: number
Execution sequence of the work order operation.
-
FirmStatus: string
Maximum Length:
30
Status of the operation firm. Valid values include Firm Start, Firm End, and Firm Range. The operation isn't firmed if this isn't specified. -
InventoryShortagePeggedFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the operation has a material shortage. If false, then the operation doesn't have a material shortage. This attribute doesn't have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotMultipleResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the resource that's the lot multiple resource. -
LotMultipleResourceId: integer
(int64)
Value that uniquely identifies the production resource that's the lot multiple resource.
-
LotMultipleResourceSetCode: string
Maximum Length:
100
Abbreviation that identifies the resource set with the lot multiple resource. -
OperationCode: string
Maximum Length:
300
Abbreviation that identifies the operation. -
operationMaterials: array
Operation Materials
Title:
Operation Materials
The Operation Materials resource manages the items that are either produced or consumed during the manufacturing production process. -
OperationName: string
Maximum Length:
120
Name of the operation. -
operationResources: array
Operation Resources
Title:
Operation Resources
The Operation Resources resource manages the production resources that are used for a particular operation. -
OperationSequenceNumber: number
Number that identifies the execution sequence of the operation.
-
OperationType: string
Maximum Length:
30
Type of the resource operation, which indicates if it's an in house or and outside supplier operation. -
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
ResourceSequenceNumber: integer
Number that identifies the resource sequence of the operation.
-
ScheduledDuration: number
Duration of schedule of the operation.
-
ScheduledDurationUnit: string
Maximum Length:
30
Time unit of measure for the schedule duration of the operation. Valid values include second, minutes, hours, and days. -
ScheduledEndDate: string
(date-time)
Date when the work order operation schedule ends.
-
ScheduledStartDate: string
(date-time)
Date when the work order operation is scheduled.
-
StartDate: string
(date-time)
Date and time when the work order operation is effective.
-
Status: string
Maximum Length:
30
Status of the operation. Valid values include Open, Active, or Closed. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier for the operation.
-
SupplierName: string
Maximum Length:
360
Name of the supplier associated with the operation. -
SupplierSiteCode: string
Maximum Length:
15
Abbreviation that identifies the supplier associated with the operation. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the operation.
-
SupplyReservationsFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the work order contains supply reservations. If false, then work order doesn't contain a supply reservation. The default value is false. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationId: integer
(int64)
Value that uniquely identifies the work definition operation.
-
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It's a primary key of the work order.
-
WorkOrderNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the work order. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
Yield: number
Yield percent of the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.
Nested Schema : productionSchedulingPlans-workOrderOperations-operationMaterials-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
IssuedQuantity: number
Quantity issued on the operation.
-
ItemCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialSequenceNumber: number
Number that indicates the sequence for a component item for a work order operation.
-
MaterialType: string
Maximum Length:
30
Type of material either produced or consumed by the operation. Valid values include Consumed Item and Produced Item. -
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.
-
PlanId: integer
(int64)
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.
-
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the unit of measure. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationMaterialId: integer
(int64)
Value that uniquely identifies the component item for a work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productionSchedulingPlans-workOrderOperations-operationResources-item-response
Type:
Show Source
object
-
AllowOffloading: string
Maximum Length:
1
Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value. -
CapacityRequired: number
Number of alternate resource instances. Valid values include Labor or Equipment.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Duration: number
Duration of the resource for an operation.
-
DurationUnit: string
Maximum Length:
30
Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days. -
ExpendedDuration: number
Duration of the expended resource on the operation.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotMultiple: number
Lot multiple of the operation resource.
-
OriginalCapacityRequired: number
Capacity required for the original planned resource.
-
OriginalResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the original resource. -
OriginalResourceId: integer
(int64)
Value that uniquely identifies the original resource.
-
PlanId: integer
(int64)
Value that uniquely identifies the production schedule.
-
PrimaryResourceId: integer
(int64)
Value that uniquely identifies the primary resource.
-
PrincipalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value. -
RemainingDuration: number
Duration that's remaining.
-
ResourceActivityName: string
Maximum Length:
80
Name of the resource activity. -
ResourceAssignmentFixedFlag: boolean
Maximum Length:
1
Contains one of the following values: Yes or No. If Yes, then the resource can't be offloaded because the work order has been transacted. If No, then the resource can be offloaded. This attribute doesn't have a default value. -
ResourceCode: string
Read Only:
true
Maximum Length:300
Abbreviation that identifies the production resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the production resource. It's a primary key of the resource.
-
ResourceSequenceNumber: number
Number that identifies the resource sequence of the operation resource.
-
ScheduledFlag: boolean
Maximum Length:
1
Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value. -
WorkCenterCode: string
Read Only:
true
Maximum Length:100
Abbreviation that identifies the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key of the work center.
-
WorkDefinitionOperationResourceId: integer
(int64)
Value that uniquely identifies the work definition operation resource.
-
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
-
WorkOrderOperationResourceId: integer
(int64)
Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source