Manufacturing Part Master data integration¶
The integration APIs in the ManufacturingPartService and the InventoryPartService Projections enable integration of Manufacturing Master data with a third party system.
The APIs are Restful Post APIs that return information structures based on filter conditions in the payload body. Refer to API documentation for full list of API attributes and payload examples.
InventoryPartService¶
Projection in the INVENT component. Since this API is not in the MFGEXE component it is not tied to the MES permission set MANUF_EXECUTION.
GetPartInformation¶
The InventoryPartService Projection contain the GetPartInformation integration API. This API returns a structure containing inventory part and characteristics information. Filter conditions in the payload allows to select information to be returned on all parts in the site, on a specific part or parts that have had the inventory part information updated within a given number of days. Changes in characteristics information does are not considered in the change filter.
ManufacturingPartService¶
The ManufacturingPartService Projection, in the MFGEXE component, contains the integration APIs GetParts, GetPartStructureInformation, GetPartRecipeStructure and GetPartRoutingInformation.
GetParts¶
Returns a list of inventory parts and general part information. The general part information regards that is not covered in the InventoryPartService API. With each part follow a list of connected Product structures and Routings connected to the part. This list is split based on revisions and their alternates. The information returned is meant to be used as input keys in subsequent APIs in the ManufacturingPartService Projection.
The filter options in the payload body can return all inventory parts on a site, a specific part number, part type, inventory part status, or based on if the part recently have been updated. The time filter regards changes that have updated the tables for the Main Master Part tab and the Main Inventory Part tab, Routing Header, Routing Alternate, Routing Operation, Routing Tool, Routing Guidelines, Structure Header, Structure Alternate, Structure Components or Structure Guidelines for the specified part.
Deleted lines are not captured as a recent change. The ChangedSinceNumberOfDays
filter only reads from the change date in the lines and does not store any separate logs. This information disappear when a line is deleted. In cases when lines have to be deleted it is recommended to update the revision to capture the change in this API.
GetPartStructureInformation¶
Returns product structure information and a list with component information and connected guidelines. Based on input of site, Part, Revision, Alternate & Structure Type. Planning Part Structure and Configuration Part Structure are not supported.
GetPartRecipeStructure¶
Returns recipe information and a list with of component information and connected guidelines. Based on input of site, Part, Revision, Alternate & Structure Type.
GetPartRoutingInformation¶
Returns routing information and a list with of operation information and connected tools & guidelines. Based on input of site, Part, Revision, Alternate & Routing Type. Routing structures for Configuration parts is not supported.
Example of use case¶
A external MES system requiring Bill Of Materials and and Routing Operation part master data; can use the GetParts API to request general information about parts on a site. The response can then be used to iterate requests from GetPartStructureInformation & GetPartRoutingInformation APIs to get detailed information for each part. This can be orchestrated by a middleware that enriches and transforms the information and passes it on to the MES.
The same process can also keep the parts in the MES updated. Utilizing the change filter in the GetParts API removes unnecessary network traffic and loads.