Windchill

Use PTC Windchill REST Services (WRS) 2.7 to manage engineering documents. Documents have a number, revision and iteration, lifecycle state, folder, security labels, and checkout status.

Connection and identifiers

Connect with a Basic-authenticated account and a complete versioned OData service root, such as https://your-host/Windchill/servlet/odata/v6. OAuth-fronted deployments are not supported. Most actions require an object identifier (OID), such as OR:wt.doc.WTDocument:48796581, returned by a list or get action; a document number is not an OID.

Working with documents

List actions accept OData filters, sorting, field selection, page size, and latest-version filtering. Structure lookup follows usage links to child documents, including their versions and states.

Create one document or a batch in a container and optional folder. Update editable attributes separately from Update Common Properties, which changes Name, Number, and Organization and is refused while the document is checked out.

Check out and check in documents with notes, undo checkout, revise, inspect valid state transitions, or change lifecycle state. Bulk lifecycle and document actions use atomic provider requests: a rejected object rolls back the collection action.

Download primary content or an attachment by OID as a Sim file. Upload primary content to a document that has none, or add attachments. Sim handles the CSRF token and multi-step upload handshake.

Use the block

Integrate PTC Windchill REST Services 2.7 document management into your workflow using Basic authentication. Read and update document metadata, perform version and lifecycle actions, and transfer primary content and attachments. Windchill OAuth deployments are not currently supported.

Actions

Windchill List Documents

List documents with an OData query, sorting, and pagination

Windchill Get Document

Get a WT.Document by OID

Windchill Get Document Structure

Retrieve recursive document usage links and their parent and child documents

Windchill Get Valid State Transitions

Get lifecycle states a document can transition to from its current state

Windchill Get Primary Content

Get primary-content metadata for a document

Windchill List Attachments

List attachment metadata for a document

Windchill Create Document

Create one WT.Document

Windchill Create Documents

Create several documents in one atomic Windchill request

Windchill Update Document

Update one document's editable attributes

Windchill Update Common Properties

Update a document's Name, Number, and other common properties

Windchill Update Documents

Update several documents' editable attributes in one atomic request

Windchill Delete Document

Delete one document

Windchill Delete Documents

Delete multiple documents atomically

Windchill Check Out Document

Check out one document

Windchill Check Out Documents

Check out multiple documents atomically

Windchill Check In Document

Check in one document

Windchill Check In Documents

Check in multiple documents atomically

Windchill Undo Check Out Document

Undo checkout for one document

Windchill Undo Check Out Documents

Undo checkout for multiple documents atomically

Windchill Revise Document

Create a new revision of one document

Windchill Revise Documents

Create new revisions of multiple documents atomically

Windchill Set Lifecycle State

Transition a document to a valid lifecycle state

Windchill Update Document Security Labels

Update installed security-label attributes for one or more documents

Windchill Download Primary Content

Download primary content into a canonical UserFile

Windchill Upload Primary Content

Upload a primary-content file to a document that has none

Windchill Download Attachment

Download a document attachment into a canonical UserFile

Windchill Upload Attachments

Upload one or more files as document attachments