Functions Available in the PTC Manufacturing Process Management Domain
The following are some of the key functions available in the PTC Manufacturing Process Management domain:
allProcessPlans()
The function allProcessPlans() returns a collection of all the versions of all the Process Plans related to a Material (WTPart) object.
The following is an example of the allProcessPlans() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.allProcessPlans()
latestProcessPlans()
The function latestProcessPlans() returns a collection of only the latest versions of all the Process Plans related to a Material (WTPart) object.
The following is an example of the latestProcessPlans() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.latestProcessPlans()
Operations()
The function Operations() returns the Operations and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the Operations() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.Operations(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
Sequences()
The function Sequences() returns the Sequences and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the Sequences() function.
GET /Windchill/servlet/odata/MfgProcMgmt/ProcessPlans('{ProcessPlanId}')/PTC.MfgProcMgmt.Sequences(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
OperatedOnParts()
The function OperatedOnParts() returns the Operated on Parts and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the OperatedOnParts() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.OperatedOnParts(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
StandardProcedures()
The function StandardProcedures() returns the Standard Procedures and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the StandardProcedures() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.StandardProcedures(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
OperationHolders()
The function OperationHolders() returns the Operation Holders and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the OperationHolders() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.OperationHolders(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
ConsumedParts()
The function ConsumedParts() returns the consumed or allocated parts and their attributes for a given operation for the specified navigation criteria.
Pass the IDs of the two navigation criteria processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. The navigation criteria IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the ConsumedParts() function with two parameters:
GET /Operations('{OperationID}')/PTC.MfgProcMgmt.ConsumedParts(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
ConsumedParts()
The function ConsumedParts() returns the consumed or allocated parts and their attributes for a given operation or a standard operation.
Pass the three parameters processPlanNavigationCriteriaId, relatedAssemblyNavigationCriteriaId, and operationPath as the input parameters. The navigation criteria IDs are the saved filters that you want to use as the filter criteria.
The operation path contains information about one or more usage links for a given standard operation that exists under different operation holders (process plan, sequence, operation) in the structure.
 |
A valid operation path traverses from the specified standard operation with consumed parts to its immediate parent operation holder, which is not a standard operation.
For more information on operationPath, see the Reading the BOP for the Specified Standard Operation Along with the Associated Consumed Parts example topic.
|
The following is an example of the ConsumedParts() function with three parameters:
|
|
• When you specify an operation in the request URI, operationPath is ignored and the function returns the consumed parts and their attributes for the specified navigation criteria for the given operation.
• When you specify a standard operation in the request URI, the function returns the consumed parts and their attributes for the specified navigation criteria and operation path for the given standard operation.
|
GET /Operations('{OperationID}')/PTC.MfgProcMgmt.ConsumedParts(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}',operationPath='{operationPath}')
AllocatedWorkCenter()
The function AllocatedWorkCenter() returns the allocated Work Center and its attributes for the specified Navigation Criteria.
Pass Navigation Criteria ID, that is, the ID of the filter saved in Windchill as the input parameter.
The following is an example of the AllocatedWorkCenter() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.AllocatedWorkCenter(navigationCriteriaId='{navigationCriteriaId}')
LocalizedOperations()
The function LocalizedOperations() returns the localized Operations and their attributes for a Process Plan for the specified Navigation Criteria.
Pass Navigation Criteria ID, that is, the ID of the filter saved in Windchill and the Process Plan ID as the input parameters.
The following is an example of the LocalizedOperations() function.
GET /Windchill/servlet/odata/MfgProcMgmt/WorkCenters('{WorkCenterId}')/PTC.MfgProcMgmt.LocalizedOperations(navigationCriteriaId='{navigationCriteriaId}',processPlanId='{processPlanId}')
ConsumedSkills()
The function ConsumedSkills() returns the consumed Skills and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the ConsumedSkills() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.ConsumedSkills(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
ConsumedProcessMaterials()
The function ConsumedProcessMaterials() returns the consumed Process Materials and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the ConsumedProcessMaterials() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.ConsumedProcessMaterials(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
ConsumedResources()
The function ConsumedResources() returns the consumed Resources and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the ConsumedResources() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.ConsumedResources(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
ConsumedToolings()
The function ConsumedToolings() returns the consumed Toolings and their attributes for the specified Navigation Criteria.
Pass the IDs of the two Navigation Criteria, processPlanNavigationCriteriaId and relatedAssemblyNavigationCriteriaId as the input parameters. These IDs are the saved filters that you want to use as the filter criteria.
The following is an example of the ConsumedToolings() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/PTC.MfgProcMgmt.ConsumedToolings(processPlanNavigationCriteriaId='{processPlanNavigationCriteriaId}',relatedAssemblyNavigationCriteriaId='{relatedAssemblyNavigationCriteriaId}')
GetDynamicStructureRepresentation()
The function GetDynamicStructureRepresentation() returns the URL for the dynamic structure representation for the specified Material, that is, WTPart.
The function accepts NavigationCriteriaId as the input parameter. It is an optional parameter. If the navigation criteria ID is not specified, the function uses the default navigation criteria to generate the URL for the dynamic structure.
You can use the URL to load the representation in the Creo View WebGL Viewer.
The following is an example of the GetDynamicStructureRepresentation() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.GetDynamicStructureRepresentation()
The following is an example of the GetDynamicStructureRepresentation() function with the navigation criteria ID passed as input parameter.
GET /Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.GetDynamicStructureRepresentation(NavigationCriteriaId='{NavigationCriteriaId}')
GetDynamicStructureRepresentationPVZ()
The function GetDynamicStructureRepresentationPVZ() generates and returns the dynamic structure representation PVZ from the specified Material, that is, WTPart.
Pass NavigationCriteriaId and IncludeAnnotations as the input parameters. The navigation criteria is an optional parameter. If the navigation criteria ID is not specified, the function uses the default navigation criteria. You can specify to either include the annotations or not using true or false, respectively.
The following is an example of the GetDynamicStructureRepresentationPVZ() function with the navigation criteria ID passed as input parameter.
GET Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.GetDynamicStructureRepresentationPVZ(NavigationCriteriaId='{NavigationCriteriaId}',IncludeAnnotations={IncludeAnnotations})
GetValidStateTransitions()
The function GetValidStateTransitions() retrieves the valid state transitions for objects such as a Process Plan, Operation, Sequence, Standard Procedure, Resource, Standard CC, or Material (WTPart).
The following is an example of the GetValidStateTransitions() function.
GET Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.GetValidStateTransitions()
IsCheckoutAllowed()
The function IsCheckoutAllowed() checks if Check Out is allowed on objects such as a Process Plan, Operation, Sequence, Standard Procedure, Resource, Standard CC, or Material (WTPart).
The following is an example of the IsCheckoutAllowed() function.
GET /Windchill/servlet/odata/MfgProcMgmt/Materials('{MaterialId}')/PTC.MfgProcMgmt.IsCheckoutAllowed()
DownloadUrls()
The function DownloadUrls() returns the download URLs for a representation associated with a DocumentManageables object such as a process plan, a standard procedure, an operation, a standard control characteristic, or a sequence.
The following is an example of the DownloadUrls() function for a DocumentManageables object.
GET Windchill/servlet/odata/MfgProcMgmt/DocumentManageables('{DocumentManageableId}')/PTC.MfgProcMgmt.DownloadUrls()
The following is an example showing how to read the bill of process (BOP) and additionally retrieve the download URLs.
GET /ProcessPlans('{ProcessPlanId}')/PTC.MfgProcMgmt.GetBOP?$expand=DownloadUrls
When a C3DI illustration file is published on an operation, the DownloadUrls() function for the operation returns:
• The following download URLs when the illustration has figures associated with it:
◦ URL for the default representation ZIP file.
◦ URL for each figure derived from the C3DI illustration file published on the operation.
◦ URL for each PVZ file corresponding to its figure.
|
|
A PVZ file associated with its figure is indicated by the same key-value pair imagesrc=<filename.pvz>, appended to both the PVZ URL and the figure URL returned in the response.
|
• Only the URL for the default representation ZIP file when the illustration does not have any figures associated with it.
|
|
The download URLs returned for an operation are sorted in the same order as in a work instruction generated in Windchill.
|
GetAssignedExpression()
The function GetAssignedExpression() returns the assigned usage expression for each of the MPM links marked as “Expression Assignable”.
The following is an example of the GetAssignedExpression() function.
GET Windchill/servlet/odata/MfgProcMgmt/Operations('{OperationId}')/OperationToPartLink('{MPMOperationToPartLinkId}')/PTC.MfgProcMgmt.GetAssignedExpression()
Refer to the domain EDM for a complete list of functions.