PTC Visualization Domain
The PTC Visualization (Visualization) domain provides access to the visualization services of Windchill.
Use Windchill Visualization Services (WVS) to publish lightweight representations of native document content in Windchill. These lightweight representations are then stored in the Windchill database and can be viewed, managed and modified. You can open and view representations of Windchill objects, such as a CAD Document, EPMDocument, and document in Creo View. You can also annotate the primary content and attachments of a Windchill document in Creo View.
Use the PTC Visualization domain to view the representations in Creo View and download the CAD data.
The following table lists the significant OData entities available in the PTC Visualization domain. To see all the OData entities available in the PTC Visualization domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL, /Windchill/servlet/odata/Visualization/$metadata.
|
Items
|
OData Entities
|
Description
|
||
|---|---|---|---|---|
|
Windchill representation
|
Representation
|
The Representation entity is a lightweight representation of CAD data that is stored in Windchill and is associated with parts and documents. The entity returns the following URLs, which you can use to launch Creo View to view the representations and download the CAD data:
• CreoViewURL
• CreoViewWebURL (Returned only when Creo View Web has been installed with Windchill.)
• 3DThumbnailURL
• 2DThumbnailURL
• AdditionalFiles
For more information, see the URLs Retrieved in the Representation Entity section.
The entity further returns information about the content of the additional files associated with a specific representation using the /AdditionalFilesData navigation.
For more information on the navigation property available in the Representation entity, see the Navigation Property Available for the Representation Entity section.
|
In addition to the entities, this domain also contains the RepresentationHyperlink complex type, which retrieves additional information for a Representation. It contains a URL and additional attributes such as Object ID, Comments, Description, FormatIcon, CreatedOn, LastModified, FileName, FileSize, MimeType, Format, and so on.
URLs Retrieved in the Representation Entity
Windchill Visualization Services converts CAD, XML, document, and other data formats into a neutral file format. The converted data is stored as a representation. You can view representations as thumbnail images, which are displayed on information pages of parts and listings throughout Windchill.
In Windchill REST Services, the Representation entity retrieves the following URLs:
• CreoViewURL—The URL used to launch the Creo View Desktop and open the specified representation.
• CreoViewWebURL—The URL used to open the specified representation in Creo View Web, installed with Windchill.
• 3DThumbnailURL—The URL for 3D thumbnail.
• 2DThumbnailURL—The URL for 2D thumbnail.
• AdditionalFiles—The URL used to download additional files, which are non-native Creo View files. These files are associated with the specified representation.
You can use these URLs to open and view representations and download the CAD data.
The URLs are returned in the response body. Along with the URLs, the entity also retrieves attributes such as FileSize, MimeType, FileName, Format, and so on for 3D thumbnail, 2D thumbnail, and additional files.
For example, to retrieve the URLs for Creo View, Creo View Web, thumbnails, and additional files associated with a specific representation, use the following GET request:
GET /Windchill/servlet/odata/Visualization/Representations('OR:wt.viewmarkup.DerivedImage:786687')
Navigation Property Available for the Representation Entity
AdditionalFilesData—Returns the URLs and attributes for AdditionalFiles and information about the content of the associated additional files for a given representation.
For example, use the following GET request:
GET /Windchill/servlet/odata/Visualization/Representations('OR:wt.viewmarkup.DerivedImage:786687')/AdditionalFilesData