PTC Document Management Domain
The Document Management domain provides access to the document management capabilities of Windchill. It enables you to create documents. You can upload and download content from documents.
You can also create classified documents. To create a classified document object using Windchill REST Services, follow the same initial steps as in the Windchill user interface. Import the classification structure, create a classification binding attribute on the document object, and use the endpoints with relevant payload to create a classified document. For more information on classifying objects, see the Windchill Help Center.
You can also update the classification attributes for existing classified documents.
When creating or updating a classified document, the request returns the relevant error messages if you specify an incorrect classification node name, attribute name, or attribute value.
The following table lists the significant OData entities available in the Document Management domain. To see all the OData entities available in the Document Management domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL.
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Business document
|
Document
|
The Document entity represents a document version. In Windchill, use the WTDocument and WTDocumentMaster classes to work with document versions.
|
|
Content information
|
ContentInfo
|
The ContentInfo entity contains content information which is used in Stage 3 for uploading content to the document.
|
|
Document Structure
|
DocumentUsageLink
DocStructure
|
• The DocumentUsageLink entity represents the document structure that can be expanded to retrieve the parent and child documents in the structure.
For information on the navigation properties available in the DocumentUsageLink entity, see the Navigation Properties Available for the DocumentUsageLink Entity section.
• The DocStructure entity represents the document structure that can be expanded to retrieve the parent and its child documents, along with the path details.
|
|
Document Usage Link
|
DocumentUse
|
The DocumentUse entity represents the link between a parent document and its child document. It contains the structureOrder attribute that represents the order of the child document within the structure. In Windchill, the WTDocumentUsageLink class represents this association.
|
 |
Although Security Labels cannot be specified as part of the content upload using the WRS Document Management domain, all security label constraints for file vaulting are respected for WRS.
|
Navigation Properties Available for the DocumentUsageLink Entity
The following navigation properties are available for the DocumentUsageLink entity:
• DocUsedBy—Retrieves the parent document in the document structure.
• DocUses—Retrieves the child document in the document structure.