Action Available in the PTC CAD Document Management Domain
The following action is available in the PTC CAD Document Management domain:
GetStructure
The action GetStructure returns a CAD structure. The action is bound to the CADDocument entity.
You can expand the CADDocument and CADDocumentUse navigation properties for more details of the documents.
When you call the GetStructure action in the request body of the URL, you can specify the ID of the NavigationCriteria. This is the ID of the saved filter you want to use as the filter criteria. If you do not specify the ID of the filter in the request body, then the default filter is used to work with the CAD structure. Alternatively, you can specify the navigation criteria in the request payload.
The action additionally returns an attribute Resolved in the response body. The attribute indicates if the link to the document is resolved in the configuration specification. The attribute returns the boolean value true or false depending on whether the link is resolved.
When you call the GetStructure action, the following additional URLs are returned:
• PVTreeId is the occurrence path of the CAD assembly to its member subcomponents in the viewable file. The complete path from the root of the BOM structure is returned. This URL can be used to work with Visualization tree. For example, in an application you consume this URL and highlight the component in the Visualization tree.
• PVParentTreeId is the occurrence path to the parent of the component part in the viewable file. The complete path from the root of the BOM structure is returned.
The action supports the parameter BOMMembersOnly. If you specify BOMMembersOnly as true in the request body, only the CAD documents that participate in the BOM structure are returned. The default value of BOMMembersOnly is false. If the request body is empty, the default value of the parameter is used, and all the structure members are returned.
 |
If the BOM structure contains documents that do not contribute to the BOM, and the user does not have access to such documents, then even though the BOMMembersOnly parameter is set to true in the request body and navigation criteria, the unresolved dependents are returned.
|
In the request body, use the following code to specify the BOMMembersOnly parameter:
{
"BOMMembersOnly" : true
}
"BOMMembersOnly" : true
}
The preferences set for the Auto Associate action in Windchill are honored by GetStructure while returning the structure. The document types and subtypes added in this preference do not participate in the BOM structure of the CAD document.
For example, CAD documents are not included in the structure in the following cases when BOMMembersOnly is set to true:
• If you add the document types and subtypes in the following preference:
> > > >
• If the CAD document has a reusable attribute set in the following preference:
> > > >