Get one active operation
get
/fscmRestApi/resources/11.13.18.05/workOrders/{WorkOrderId}/child/WorkOrderActiveOperation/{WorkOrderOperationId}
Request
Path Parameters
-
WorkOrderId(required): integer(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
-
WorkOrderOperationId(required): integer(int64)
Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation.
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:
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 : workOrders-WorkOrderActiveOperation-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date-time)
Read Only:
true
Actual finish date of the operation. -
ActualStartDate: string
(date-time)
Read Only:
true
Actual start date of the operation. -
AdditionalMaterialAtManualIssue: string
Title:
Additional Manual Material Issue
Maximum Length:30
Value that controls whether a production operator can issue more than the required quantity while manually reporting material issues. You can issue more than the required quantity without any hindrance, or prevent the material issue in case of additional material issue. -
AutoTransactFlag: boolean
Title:
Automatically Transact
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. The count point attribute and the automatically transact attribute are mutually exclusive. You must make sure that each of these attributes do not both contain true. If count point and automatically transact each contain false, then the operation is optional. You can manually report component usage and resource usage for an optional operation. This attribute doesn't have a default value. -
CompletedQuantity: number
Title:
Completed
Read Only:true
Quantity that's finished for the operation. -
CountPointOperationFlag: boolean
Title:
Count Point
Maximum Length:1
Contains one of the following values: true or false. If true, then this operation is a count point operation. If an operation is a count point operation, then you have to manually complete it. If false, then this operation isn't a count point operation. The last operation in a work order should always be a count point operation. This attribute doesn't have a default value. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the operation. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the operation. -
DelayStatus: integer
Read Only:
true
Delay status of the work order or work order operation. It contains one of the following values. 0: no delay; 1: a delay exists in starting the work order operation; 2: a delay exists in finishing the work order operation; 3: a delay exists in one or more of the work order operations. -
ExecutionSequence: number
Read Only:
true
Number that indicates the execution sequence of operations when the work order allows resequencing. It is a read-only value. This attribute is associated with a feature that requires an opt in. -
FixedLeadTime: number
Title:
Fixed
Lead time to perform this outside processing (OSP) operation independent of the quantity of the OSP item. -
InProcessQuantity: number
Title:
In Process
Read Only:true
Quantities that are complete at the prior count point operation, and that are awaiting delivery to the supplier operation. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the work order operation. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login of the user who most recently updated the work order operation. -
LeadTimeUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the lead time uses for the supplier operation. -
LeadTimeUOM: string
Title:
UOM
Maximum Length:3
Abbreviation that identifies the unit of measure that the lead time uses. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaterialsCount: integer
Read Only:
true
Count of the components that the application requires to perform this operation. -
OperationCompletionWithOpenExceptions: string
Title:
Completions with Open Exceptions
Maximum Length:30
Value that controls whether operation completion is allowed when open exceptions exist for an operation. You can complete an operation without any hindrance, allow with a warning, or prevent operation completion. -
OperationCompletionWithUnderIssue: string
Title:
Completions with Under Issues
Maximum Length:30
Value that controls whether operation completion is allowed when less than the required quantity of material is issued. You can complete an operation without any hindrance, allow with a warning, or prevent operation completion. -
OperationDescription: string
Title:
Description
Maximum Length:240
Description of the operation. -
OperationName: string
Title:
Name
Maximum Length:120
Name of the operation. -
OperationSequenceNumber: number
Title:
Sequence
Sequence to use when performing the work order operations. -
OperationType: string
Title:
Operation Type
Maximum Length:30
Default Value:IN_HOUSE
Type of operation. It includes one of the following values. IN_HOUSE: the organization that owns the work order performs the operation. SUPPLIER: a supplier performs the operation. -
OperationTypeDescription: string
Read Only:
true
Maximum Length:255
Description of the operation type. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It is a primary key of the inventory organization. -
OSPItemDescription: string
Read Only:
true
Maximum Length:255
Description of the outside processing (OSP) item. -
OSPItemId: integer
(int64)
Title:
Outside Processing Item
Value that uniquely identifies outside processing (OSP) item. It is a primary key that the application generates when it creates an item. -
OSPItemNumber: string
Maximum Length:
300
Number that identifies outside processing (OSP) item. -
OverReceiptQuantity: number
Read Only:
true
Over receipt quantity of the purchase order line for this outside processing operation. -
PlannedCompletionDate: string
(date-time)
Title:
Completion Date
Planned date and time to finish the operation. The scheduling application sets this date. The planned completion date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required. -
PlannedStartDate: string
(date-time)
Title:
Start Date
Planned date and time to start the operation. The scheduling application sets this date. The planned start date must not occur before the start date of the work order or after the finish date of the work order. This attribute is required. -
POApprovedQuantity: number
Read Only:
true
Approved quantity on the purchase order created for this outside processing operation. -
PORequestedQuantity: number
Read Only:
true
Quantity requested to create the purchase requisition for this outside processing operation. -
ReadyQuantity: number
Title:
Ready
Read Only:true
Quantity that's ready for the operation. -
ReceivedQuantity: number
Read Only:
true
Received quantity for this outside processing operation. -
RejectedQuantity: number
Title:
Rejected
Read Only:true
Quantity rejected, if any, for the operation. -
ResequenceFlag: boolean
Title:
Allow Resequencing
Maximum Length:1
Contains one of the following values: true or false. If true, then the work order has resequence operations. If false, then the work order doesn't have resequence operations. This attribute is associated with a feature that requires an opt in. -
ResourcesCount: integer
Read Only:
true
Count of the resources that the application requires to perform this operation. -
ScrappedQuantity: number
Title:
Scrapped
Read Only:true
Quantity scrapped, if any, for the operation. -
SerialTrackingFlag: boolean
Title:
Serialization
Read Only:true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then enforce serial tracking for the operation. If false, then do not enforce. The work definition that the work order references provides this value. The default value is false. -
ShippedQuantity: number
Read Only:
true
Shipped quantity for this outside processing operation. -
ShippingDocumentsFlag: boolean
Title:
Generate shipment
Maximum Length:1
Contains one of the following values: true or false. If true, then create shipping documents for this outside processing (OSP) operation. If false, then do not create these shipping documents. This attribute doesn't have a default value. -
StandardOperationCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
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.
-
StandardOperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the standard operation. -
SupplierId: integer
(int64)
Value that uniquely identifies outside processing (OSP) supplier. It is a primary key that the application generates when it creates a supplier.
-
SupplierName: string
Maximum Length:
255
Name of the outside processing (OSP) supplier. -
SupplierSiteCode: string
Maximum Length:
255
Abbreviation that identifies the supplier site. -
SupplierSiteDescription: string
Read Only:
true
Maximum Length:255
Description of the supplier site. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies supplier site. It is a primary key that the application generates when it creates a site of a supplier.
-
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the quantity uses for the operation. -
VariableLeadTime: number
Title:
Variable
Lead time to perform this outside processing (OSP) operation for each unit of the OSP item. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
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. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Title:
Work Center
Value that uniquely identifies the work center. It is a primary key that the application generates when it creates the work center. -
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkOrderId: integer
(int64)
Value that uniquely identifies the work order. It is a primary key that the application generates when it creates the work order.
-
WorkOrderNumber: string
Title:
Work Order
Read Only:true
Maximum Length:120
Number that identifies the work order. This number is unique in the manufacturing organization. The user can manually assign the number when the user creates the work order, or can allow the application to create a unique number from the numbering scheme defined by these plant parameters: Work Order Prefix or Work Order Starting Number. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It is a primary key that the application generates when it creates the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
This example describes how to get one active operation for work orders.
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/WorkOrderActiveOperation/WorkOrderOperationId"
For example, the following command gets active operation 300100081228167 in work order 300100081228166:
curl -u username:password "https://servername/fscmRestApi/resources/version/workOrders/300100081228166/child/WorkOrderActiveOperation/300100081228167"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationId" : 207, "WorkOrderId" : 300100081228166, "WorkOrderNumber" : "1059", "WorkOrderOperationId" : 300100081228167, "OperationSequenceNumber" : 10, "OperationName" : "10", "OperationDescription" : null, "StandardOperationId" : null, "StandardOperationName" : null, "StandardOperationCode" : null, "WorkAreaId" : 300100071642832, "WorkAreaCode" : "MFGASSYWA1", "WorkAreaName" : "MFGASSYWA1", "WorkAreaDescription" : "Assembly Work Area1", "WorkCenterId" : 300100071642871, "WorkCenterCode" : "MFGASSY1", "WorkCenterName" : "MFGASSY1", "WorkCenterDescription" : "Work Center for Assembly", "CountPointOperationFlag" : true, "AutoTransactFlag" : false, "ReadyQuantity" : 8, "CompletedQuantity" : 2, "ScrappedQuantity" : null, "RejectedQuantity" : null, "UnitOfMeasure" : "Each", "PlannedStartDate" : "2015-12-09T09:00:00-07:00", "PlannedCompletionDate" : "2015-12-09T09:00:00-07:00", "ActualStartDate" : null, "ActualCompletionDate" : null, "DelayStatus" : 2, "MaterialsCount" : 2, "ResourcesCount" : 0, "SerialTrackingFlag" : false }