Get Shop Floor Information¶
These services provide information about shop orders and operations. Note that some of these REST API Services utilize a POST request format and require an input payload but otherwise function like normal read-only GET requests with a response body.
Get Operation Info¶
This service retrieves shop order operation information for a specific operation. The required input payload is either an Operation ID
or a combination of Order number
, Release number
, Sequence number
, and Operation number
.
The returned information attributes are Site
, Work Center
, Work Center description
, Resource ID
, Operation ID
, Order Number
, Release Number
, Sequence Number
, Operation Number
, Operation Sequence Number
, Part Number
, Part Description
, Executable Quantity
, Remaining Quantity
, Operation Status
, Planned Start Time
, Default Location
, Work Guidelines
, Machine Instructions
, subtasks
, Lot Batch Numbers
, Serial Numbers
, Inspection/analysis Data Points
, Handling Units
, Tools
.
Get Order Components¶
This service returns shop order component information. It requires input information consisting of Order number
, Release number
, and Sequence number
.
The returned information attributes are Site
, Part Number
, Structure Type
, Structure Revision
, Structure Alternate
, Drawing Number
, Drawing Number Revision
and array of component details: Line Item Number
, Component Part Number
, Component Part Description
, Material Line Status
, Required Date
, Unit of Measure
, Quantity per Assembly
, Component Scrap Quantity
, Scrap Factor
, Quantity Required
, Operation Number
, Operation Description
, Reserve Issue Method
, Quantity Reserved
, Quantity on Pick List
, Quantity Issued
, Reserve Issue From Location
, Mrb Exists
, Configuration Id
, Activity Sequence
and Work Guidelines
detail.
Get Order Operations¶
This service retrieves shop order operation information based on the input of Order number
, Release number
, and Sequence number
.
The returned information includes details such as Part Number
, Routing Revision
, Routing Alternate
, Production Line
, and an array of operation information, for all operations on the order, using the structure from Get Operation Info.
Get Next Executable Operation¶
This service returns the Get Operation Info structure for the next executable operation based on Site
, Work Center
, and Resource ID
.
Get Current Operations¶
Based on Site
, Work Center
, and Resource ID
, this service returns the Get Operation Info structure for the current ongoing activities.
Get Shop Orders¶
This service provides a list of Shop Orders information. It requires only the Site
as input. Orders in "complete" or "canceled" status are not returned, while orders in all other statuses are included in the response. Always apply a filter when using Get Shop Orders to limit the query and avoid straining system performance.
The returned information attributes are Order Number
, Release Number
, Sequence Number
, Shop Order Type
, Part Number
, Part Revision
, Start Date
, Finish Date
, Need Date
, Earliest Start Date
, Lot Size
, Received Quantity
, Proposed Location
, Process Type Code
, Project Activity Sequence ID
, Priority Category
, Configuration ID
, Packing Instruction ID
, Part Description
, Order Status
, Material Status
, Operation Status
, Product Status
, Packing Instruction Description
, Priority Category Description
, Proposed Location Description
and Interruption Exists
.
ODATA filter in Get Shop Orders¶
Always apply a filter when using this service to limit the query. Limiting the query helps avoid system performance issues and simplifies the response message. You can find more information about ODATA query options here
A GET request without a filter will return all available orders on the specified site, such as "SW1A" in the image below.
To limit the Get Shop Orders query, add a filter at the end of the API service URL.
In this image, a filter is applied to retrieve orders with a RevisedStartDate
greater than "2023-06-07 17:00:00" and Status
equal to "started." The query syntax parameters are added as follows:
?$filter=RevisedStartDate gt 2023-06-07T17:00:00Z and Status eq 'Started'
Filter limitations and considerations¶
The attributes Part Revision
and Lot Size
cannot be filtered due to a technical limitation.
When filtering on enumerations, you need to convert the data type from a string to an enumeration in the input. To determine if an attribute is an enumeration, refer to the API documentation in the API explorer.
The image displays the Shop Order Type
attribute and its enumerations.
Example Shop Order Type
To filter on "Manufacturing" in the OrderCode
attribute, the following OData query line is used:
?$filter=OrderCode eq IfsApp.ShopFloorConnector.ShopOrdCode'Manufacturing'
This string, IfsApp.ShopFloorConnector.ShopOrdCode'Manufacturing'
, converts the string "Manufacturing" to the enumeration data type.
Example Product Status
To filter on "NoReceive" in the ProductStatus
attribute, use this query:
?$ProductStatus eq IfsApp.ShopFloorConnector.ShopProdState'NoReceive'
Example Operation Status
To filter on "NoReport" in the OperationStatus
attribute, use this query:
?$OperationStatus eq IfsApp.ShopFloorConnector.ShopOperState'NoReport'
Example Material Status
To filter on "NotReserved" in the MaterialStatus
attribute, use this query:
?$MaterialStatus eq IfsApp.ShopFloorConnector.ShopMtrlState'NotReserved'
Example Interruption Exists
To filter on if on orders without active Interruptions, use this query:
?$filter=InterruptionExists eq IfsApp.ShopFloorConnector.InterruptionMode'No'