Functions Available in the PTC CAD Document Management Domain
The following functions are available in the PTC CAD Document Management domain:
GetDynamicStructureRepresentation()
The function GetDynamicStructureRepresentation() returns a URL that you can use to download the dynamic structure of a Creo View representation of a CAD document. 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 CAD data in the Creo View WebGL Viewer.
The following is an example of the GetDynamicStructureRepresentation() function.
GET Windchill/servlet/odata/CADDocumentMgmt/CADDocuments('{CADDocumentId}')/PTC.CADDocumentMgmt.GetDynamicStructureRepresentation()
The following is an example of the GetDynamicStructureRepresentation() function with NavigationCriteriaId passed as the input parameter.
GET Windchill/servlet/odata/CADDocumentMgmt/CADDocuments('{CADDocumentId}')/PTC.CADDocumentMgmt.GetDynamicStructureRepresentation(NavigationCriteriaId='{NavigationCriteriaId}')
To retrieve the dynamic structure representation PVS from a CAD document with or without QuickView, you can pass EnableQuickView as the input parameter to the function with the value of the parameter specified as true or false, respectively. When the value is specified as true, the resulting dynamic structure representation PVS includes QuickView. When the value is specified as false, the resulting dynamic structure representation PVS does not include QuickView.
 |
The QuickView capability is available in Windchill 12.1.2.0 or later, and the APIs are supported starting with Windchill REST Services 2.7.
The APIs are not available in Windchill REST Services for the Windchill releases prior to the 12.1.2.0 release.
|
The following is an example of the GetDynamicStructureRepresentation() function with EnableQuickView passed as the input parameter.
GET /Windchill/servlet/odata/CADDocumentMgmt/CADDocuments('{CADDocumentId}')/PTC.CADDocumentMgmt.GetDynamicStructureRepresentation(EnableQuickView={EnableQuickView})
The following is an example of the GetDynamicStructureRepresentation() function with NavigationCriteriaId and EnableQuickView passed as input parameters.
GET /Windchill/servlet/odata/CADDocumentMgmt/CADDocuments('{CADDocumentId}')/PTC.CADDocumentMgmt.GetDynamicStructureRepresentation(NavigationCriteriaId='{NavigationCriteriaId}',EnableQuickView={EnableQuickView})
GetDynamicStructureRepresentationPVZ()
The function GetDynamicStructureRepresentationPVZ() generates and returns the dynamic structure representation PVZ from a given CAD document.
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 NavigationCriteriaId and IncludeAnnotations passed as input parameters.
GET Windchill/servlet/odata/CADDocumentMgmt/CADDocuments('{CADDocumentId}')/PTC.CADDocumentMgmt.GetDynamicStructureRepresentationPVZ(NavigationCriteriaId='{NavigationCriteriaId}',IncludeAnnotations={IncludeAnnotations})