Windchill

PTC Windchill is the product lifecycle management system manufacturers use as the system of record for engineering data. Documents in Windchill are controlled objects: each one carries a number, a revision and iteration, a lifecycle state, folder placement, security labels, and a checkout status that decides who is allowed to change it right now.

This integration talks to Windchill REST Services (WRS) 2.7 over OData — the query protocol Windchill exposes its data through — using a Basic-authenticated service account. Point it at a complete versioned service root — https://your-host/Windchill/servlet/odata/v6 — and your agents can:

• Find and read documents: list documents with an OData filter, sort order, field selection, page size, and a latest-version-only switch; fetch a single document by its object identifier (OID); and walk a document's structure through its usage links to see child documents with their versions and states.
• Create and update: create one document or a batch of them in a container and optional folder, and patch editable attributes on one or many documents. Name, Number, and Organization are rejected here and have their own operation, because Windchill changes those through a separate action and refuses it while a document is checked out.
• Run the version and lifecycle cycle: check documents out and back in with notes, undo a checkout, revise to the next revision, read the lifecycle states a document is actually allowed to move to, and transition it to one of them.
• Move files: download a document's primary content, or a specific attachment by its OID, into a Sim file — and upload files as primary content or attachments. Sim handles Windchill's CSRF token and its multi-step upload handshake for you.

Bulk actions are atomic on Windchill's side: PTC documents that if the action fails for any object in the collection, the entire action is rolled back and nothing changes.

Two limits are worth knowing before you build. Windchill identifies everything by OID (OR:wt.doc.WTDocument:48796581), so most operations need an OID you got from a list or get call rather than a document number. And this integration supports Basic authentication only — Windchill deployments fronted by OAuth are not currently supported.

Usage Instructions

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

Input

Output

Windchill Get Document

Get a WT.Document by OID

Input

Output

Windchill Get Document Structure

Retrieve recursive document usage links and their parent and child documents

Input

Output

Windchill Get Valid State Transitions

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

Input

Output

Windchill Get Primary Content

Get primary-content metadata for a document

Input

Output

Windchill List Attachments

List attachment metadata for a document

Input

Output

Windchill Create Document

Create one WT.Document

Input

Output

Windchill Create Documents

Create several documents in one atomic Windchill request

Input

Output

Windchill Update Document

Update one document's editable attributes

Input

Output

Windchill Update Common Properties

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

Input

Output

Windchill Update Documents

Update several documents' editable attributes in one atomic request

Input

Output

Windchill Delete Document

Delete one document

Input

Output

Windchill Delete Documents

Delete multiple documents atomically

Input

Output

Windchill Check Out Document

Check out one document

Input

Output

Windchill Check Out Documents

Check out multiple documents atomically

Input

Output

Windchill Check In Document

Check in one document

Input

Output

Windchill Check In Documents

Check in multiple documents atomically

Input

Output

Windchill Undo Check Out Document

Undo checkout for one document

Input

Output

Windchill Undo Check Out Documents

Undo checkout for multiple documents atomically

Input

Output

Windchill Revise Document

Create a new revision of one document

Input

Output

Windchill Revise Documents

Create new revisions of multiple documents atomically

Input

Output

Windchill Set Lifecycle State

Transition a document to a valid lifecycle state

Input

Output

Windchill Update Document Security Labels

Update installed security-label attributes for one or more documents

Input

Output

Windchill Download Primary Content

Download primary content into a canonical UserFile

Input

Output

Windchill Upload Primary Content

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

Input

Output

Windchill Download Attachment

Download a document attachment into a canonical UserFile

Input

Output

Windchill Upload Attachments

Upload one or more files as document attachments

Input

Output