Functions Available in the PTC Visualization Domain
The following functions are available in the PTC Visualization domain:
GetDynamicStructureRepresentation()
The function GetDynamicStructureRepresentation() returns a URL which you can use to download the dynamic structure of a Creo View representation. This function is bound to the Representation entity of an object. The function accepts navigation criteria NavigationCriteriaId as the input parameter. It is an optional parameter. The navigation criteria define which parts and objects are displayed in the dynamic structure. If the navigation criteria is not specified, the function uses the default navigation criteria to generate the URL for the dynamic structure.
You can use the product structure URL to load the CAD data in the WebGL viewer. The viewer uses Creo View WebGL Toolkit APIs.
GetFidelities()
You can get a list of fidelity values associated with a representation. The function GetFidelities() returns a list of fidelity values, which are represented as PTC.EnumType. The function retrieves the fidelity information in a value-display format.
GetPVZ()
You can get a compressed file from a Creo View representation. The function GetPVZ() returns a .pvz file, which contains the OL, PVS, PVT, and other Creo View files. The .pvz file is created from the associated representation. The function is bound to the Representation entity of an object.
The function contains the following parameters:
• IncludeAnnotations—Includes or excludes annotations in the .pvz file. Pass the parameter as true to include annotations, when the .pvz file is created.
• Fidelity—This is an optional parameter. Specifies the value of fidelity.
 |
The function GetPVZ() does not retrieve multi-fidelity representations for releases prior to Windchill 11.1 M020.
|
GetWVSFeatures()
You can get a list of all the Windchill Visualization Services (WVS) features or capabilities that are supported from Windchill 13.0.0.0 onwards. The GetWVSFeatures() function returns a collection of the existing WVS supported features in a name-values format. For a feature with multiple values, the function returns the values as comma-separated String values.
|
|
Starting with Windchill REST Services 2.6, the GetWVSFeatures() function retrieves existing WVS features from the Windchill 13.0.0.0 release onwards. The function returns an empty response for the Windchill releases prior to 13.0.0.0 release.
The function returns the 404 status code when requested in the releases prior to Windchill REST Services 2.6.
|
To retrieve the WVS features and values, use the following GET URI.
GET /Windchill/servlet/odata/Visualization/GetWVSFeatures()
For example, in Windchill REST Services 2.6, the function returns the following two features that WVS currently supports in Windchill 13.0.0.0:
• SeparatedsourceC3di—To support separated source data from C3DI, Creo Illustrate can query to know if WVS supports server-side C3DI publishing with separated source data.
The feature returns the String value "true" or "false". When the value is returned as "true", it indicates that WVS supports the Creo Illustrate data that persists with the separated source data from C3DI in Windchill. The value returned as "false" indicates that WVS does not support separated source data for C3DI publishing.
• zip64—Client can query to know if WVS supports extracting and loading from a zip package (.pvz or .pvoa) bundled in 64-bit compression mode.
The feature returns the String value "true" or "false". When the value is returned as "true", it indicates that the external client can send a 64-bit zipped file to WVS. When returned as "false", the external client can send only a 32-bit zipped file to WVS.
For the above features supported from Windchill 13.0.0.0 onwards, the GetWVSFeatures() function returns following values in the response:
{
"value": [
{
"featureName": "SeparatedsourceC3di",
"featureValues": [
"true"
]
},
{
"featureName": "zip64",
"featureValues": [
"true"
]
}
]
}
"value": [
{
"featureName": "SeparatedsourceC3di",
"featureValues": [
"true"
]
},
{
"featureName": "zip64",
"featureValues": [
"true"
]
}
]
}