Welcome to the Windchill Rest Services 2.3 Help Center
REST
OData
Windchill REST Services
Installing Windchill REST Services
Installation Prerequisites
Installation Process
Windchill REST Services Framework Capabilities
Overview
Support for OData
OData Services as Domains
Entity Data Model of a Domain
OData Primitives
Support for EDM Enum Type
Processing of Secure Information
OData Query Parameters
Support for $filter on Navigation Properties
Support for $orderby on Navigation Properties
Using the isof Type Checking Function in $filter Expressions
Local Time Zone Preferences
OData Prefer Headers
Support for Entity References
PTC Annotations
API Catalog for Windchill REST Services Endpoints
Developer Documents for Windchill REST Services
Processing HTTP Requests for OData URLs
Domain Configuration
Configuration Paths and Files
Configuring a Domain
Domain JSON File
Import JSON File
Versioning of the Domain API
Configuring Unbound Functions
Configuring Unbound Actions
Configuring Entities in a Domain
Basic Information for Configuring Entities
Configuring Structural Properties
Configuring Navigation Properties
Configuring Bound Functions
Configuring Bound Actions
Inheriting Windchill Capabilities
Versions of Inherited Delegates
Naming Convention for Subtypes
Excluding Subtypes of Enabled Windchill Types
Configuring Domain Specific Links
Disabling Entity Set for an Entity in the Service Document
Processing Batch Requests
Examples for Batch Requests
Support for Windchill Measurement System Preferences
Getting Information About Windchill Constraints
Getting Information About Windchill Life Cycle States
Set the Life Cycle State of an Entity
Function to Get the Value of Nonce Token
Retrieving the Latest Version of an Entity
Logging for Windchill Rest Services
Windchill REST Services Domain Capabilities
PTC Domains
Overview
PTC Product Management Domain
Actions Available in the PTC Product Management Domain
Functions Available in the PTC Product Management Domain
PTC Document Management Domain
Action Available in the PTC Document Management Domain
PTC Windchill Administration Domain
PTC BOM Transformation Domain
Actions for the BOM Transformation Domain
PTC Business Administrative Change Management Domain
BACMgmnt Domain Actions
BAC Domain Functions
PTC Data Administration Domain
PTC Principal Management Domain
PTC Common Domain
Functions Available in the PTC Common Domain
PTC Navigation Criteria Domain
PTC Dynamic Document Management Domain
PTC Parts List Management Domain
PTC Service Information Management Domain
Action Available in the PTC Service Information Management Domain
PTC Quality Domains
PTC Quality Management System Domain
PTC Nonconformance Domain
PTC Customer Experience Management Domain
PTC Regulatory Master Domain
Action Available in the PTC Regulatory Master Domain
PTC CAPA Domain
PTC Audit Domain
PTC Info*Engine System Domain
PTC Factory Domain
PTC Manufacturing Process Management Domain
Actions Available in the PTC Manufacturing Process Management Domain
PTC Change Management Domain
PTC Classification Structure Domain
Functions Available in the PTC Classification Structure Domain
PTC Visualization Domain
Functions Available in the PTC Visualization Domain
PTC Product Platform Management Domain
Action Available in the PTC Product Platform Management Domain
Functions Available in the PTC Product Platform Management Domain
PTC CAD Document Management Domain
Action Available in the PTC CAD Document Management Domain
PTC Effectivity Management Domain
PTC Event Management Domain
Function Available in the PTC Event Management Domain
PTC Reporting Domain
PTC Saved Search Domain
Functions Available in the PTC Saved Search Domain
PTC Supplier Management Domain
PTC Workflow Domain
Actions Available in the PTC Workflow Domain
Function Available in the PTC Workflow Domain
PTC UDI Domain
Actions Available in the PTC UDI Domain
Functions Available in the PTC UDI Domain
PDM Domain
Accessing Domains
Actions Available for Single and Multiple Objects
Common Navigation Properties Available in All the Domains
Examples for Basic REST Operations
Fetching a NONCE Token from a Service
Examples for the PTC Product Platform Management Domain
Example: Retrieving Option Set associated with Specific Object in a Set of Objects
Examples for the PTC Product Management Domain
Creating a Part
Creating Multiple Parts
Creating a Part in a Different Organization
Create a Part Usage Link with Occurrences
Deleting a Part Usage Link
Reading the Bill of Material (BOM)
Reading the Bill of Material (BOM) Along with Path Details
Example: Retrieving Bill of Material with Plant Filters and Config Specs
Querying the Part Using a Filter
Reading a Part by ID with Expanded Navigation
Checking Out a Part
Checking In a Part
Revising Multiple Parts
Retrieving the Components List for a Part Structure
Updating the Common Attributes of a Part
Updating Multiple Parts
Creating a Classified Part
Retrieving Information About Classification Attributes
Example: Navigating between Parts and Variant Specification
Retrieving Replacement Parts
Retrieving Replacement Parts in the Bill of Material (BOM)
Creating Associations between Parts and CAD documents
Deleting Associations between Parts and CAD Documents
Examples for the PTC BOM Transformation Domain
Example: Retrieving Department Data Objects
Example: Retrieving a Specific Department Data Object
Example: Revising a Specific Department Data Object
Example: Retrieving a Collection of Department Data Objects
Example: Retrieving Department Data Objects for a Collection of Parts Objects
Example: Retrieving Department Data Objects for a Collection of Parts Objects with Inline Navigation Criteria
Example: Retrieving Department Data Objects for a Collection of Plant Data Objects
Example: Retrieving Department Data Objects for a Collection of Plant Data Objects with Inline Navigation Criteria
Example: Revising Multiple Department Data Objects
Example: Creating a Department Data Object for a Specific Plant Data Object assigned to a Specific Parts Object
Example: Creating a Department Data Object for Multiple Plant Data Objects assigned to a Specific Parts Object
Example: Creating Multiple Department Data Objects for a Specific Plant Data Object assigned to a Specific Parts Object
Example: Creating Multiple Department Data Objects for Each Plant Data Object in a Set of Parts Objects
Example: Creating a Department Data Object for a Set of Plant Data Objects
Example: Creating Multiple Department Data Objects for a Set of Plant Data Objects
Example: Creating Multiple Department Data Objects for a Specific Plant Data Object
Example: Retrieving Extended Data Objects
Example: Retrieving Specific Types of Extended Data Objects
Example: Retrieving Versions of Extended Data Objects
Example: Retrieving Revisions of Extended Data Objects
Example: Retrieving Multiple Extended Data Objects
Example: Retrieving Extended Data Objects for Parts
Example: Retrieving Effectivities for Extended Data Objects
Example: Retrieving the Equivalence Network for Parts
Example: Checking in/Checking Out and Changing the State of Extended Data Objects
Example: Retrieving Made from Part Information for a Collection of Parts
Example: Assigning Plants for a Set of Parts
Examples for the PTC Business Administration Change Management
Example: BAC Mgmt—Export Changes to Package
Example: BAC Mgmt —Preview Changes
Example: BAC Mgmt—Save Import Mappings
Example: BAC Management — Importing a package
Example: Deleting Received BAC Deliveries
Examples for the PTC Data Administration Domain
Create a Folder and Subfolder
Update a Folder
Delete a Folder
Retrieving Folder Contents with complete Entity Representation
Retrieving Folder Contents of a Specific Type
Retrieving Folder Contents with some Attributes of a Specific Type
Examples for the Document Management Domain
Creating a Document in a Different Organization
Creating a Document
Creating Multiple Documents
Checking Out a Document
Updating a Document
Updating Multiple Documents
Uploading Content for a Document
Examples for the PTC Dynamic Document Management Domain
Example: Retrieving Member Links between Dynamic Documents
Example: Creating Member Links Between Dynamic Documents
Example: Deleting Member Links Between Dynamic Documents
Examples for the PTC Principal Management Domain
Retrieving License Groups for a User
Retrieving License Groups for a User with Expanded Navigation
Examples for the PTC Parts List Management Domain
Retrieving Parts List
Retrieving Information for a Specific Part List
Retrieving Parts List Items for a Specific Part List
Retrieving a Specific Part List Item
Retrieving Parts from a Part List with Expanded Navigation
Retrieving EPMDocuments from a Part List with Expanded Navigation
Retrieving Illustrations for a Parts List
Retrieving a Specific Illustration
Retrieving a Specific Substitute Part
Retrieving a Specific Supplementary Part
Examples for the PTC Service Information Management Domain
Retrieving Information Structures
Retrieving Publication Structures
Retrieving Publication Structures for Authoring Language French
Retrieving and Expanding the Contents of an Information Structure
Retrieving and Expanding the Contents of a Publication Structure
Example for the PTC Info*Engine System Domain
Invoking an Info*Engine Task
Examples for the PTC Manufacturing Process Management Domain
Retrieving Operations For a Process Plan Using System Default NCs
Retrieving Illustration-Related Contents from an Operation
Retrieving Document-Related Contents from a Sequence
Example: Allocating Resources to an Operation
Reading the Bill of Process (BOP)
Example: Allocating a Work Center to an Operation
Example: Deleting a Resource to Operation Association
Example: Deleting a Work Center to Operation Association
Example: Updating a Resource to Operation Association
Example: Updating a Work Center to Operation Association
Example: Creating Multiple Process Materials
Example: Creating Multiple Skills
Example: Creating Multiple Tooling Objects
Example: Creating Multiple Work Centers
Example: Creating Multiple Standard Control Characteristic Objects
Example: Retrieving Information of Manufacturing Resources
Example: Retrieving Information of Consumed Resources via a Specific Operation Object
Example: Retrieving Information of a Specific Process Material Object
Example: Retrieving Information of a Specific Tooling Object
Example: Retrieving Information of a Specific Work Center Object
Example: Retrieving Information of a Specific Skill Object
Examples for the PTC Change Management Domain
Retrieving Problem Reports
Retrieving Variances
Retrieving Variances Along with Variance Owners Information
Retrieving Change Requests
Retrieving Change Notices
Retrieving Change Tasks
Example: Reserving a Change Object
Example: Unreserving a Change Object
Creating Standalone Change Issues
Creating a Standalone Change Notice
Example: Creating Change Notices with Multiple Change Tasks
Example: Modifying Attributes for a Change Request
Example: Editing the Sequence of Change Tasks
Retrieving the Process Links for Change Objects
Retrieving Process Links for a Specific Change Object
Retrieving the Process Objects for Change Objects
Retrieving Process Objects for a Specific Change Object
Retrieving the Reference Objects for Change Objects
Retrieving Reference Objects for a Specific Change Object
Retrieving the Reference Links for Change Objects
Retrieving Reference Links for a Specific Change Object
Example: Retrieving Pending Effectivity
Example: Creating a Pending Effectivity for a Resulting Object
Example: Updating a Pending Effectivity for a Resulting Object
Deleting a Pending Effectivity for a Resulting Object
Retrieving the Affected Links
Retrieving the AffectedByLinks
Retrieving the Affected Objects
Retrieving the AffectedBy Objects
Retrieving the Affected Links and Affected Objects
Example: Retrieving Affected Object links for a Change Issue
Example: Retrieving Affected Object links for a Change Notice
Example: Retrieving Affected Object Links for a Change Request
Example: Modify Attributes for an Affected Object Link for a Change Issue
Example: Updating Attributes on an Affected Object Link for a Change Task
Retrieving and Downloading the Attachments Associated with Change Objects
Retrieving the Resulting Links
Retrieving the Resulting Objects
Retrieving the Unincorporated Links
Example: Navigating from Changeables to a Change Notice using ResultedByChangeObjects
Example: Three Stage Upload of Attachments to a Change Issue
Example: Deleting an Attachment from a Change Issue
Example: Update an Attachment on a Change Issue
Examples for the PTC Classification Structure Domain
Query Classification Nodes
Retrieving the First Child Node of a Root Node
Retrieving a Specific Classification Node
Retrieving the Parent Node of a Classification Node
Retrieving the Child Nodes of a Classification Node
Query Classified Objects
Retrieving Classified Objects Associated with a Classification Node
Retrieving a Specific Classified Object
Retrieving Legal or Enumeration values for a Classification Attribute
Retrieving Binding Attributes for Classified Object
Examples for the PTC Saved Search Domain
Retrieving Saved Searches
Executing a Saved Search
Retrieving Object Types for a Saved Searches
Examples for the PTC Visualization Domain
Retrieving a Representation
Retrieving Fidelity Names
Examples for the PTC Audit Domain
Retrieving Audits
Retrieving Information for a Specific Audit
Updating Audit Score for a Specific Audit Detail
Examples for the PTC Windchill Administration Domain
Get a Specific Audit Record
Get a Count of All Records
Get Specific Attributes of Audit Records
Get Sorted Audit Records
Get Filtered Audit Records Using a Logical Operator
Select a Specific Attribute of EventInfo
Get EventInfo Using Filters
Filtering Audit Records Based on EventTime
Examples for the PTC Product Platform Management Domain
Retrieving Options
Retrieving Option Groups for All Options
Retrieving the Option Group for a Specific Option
Retrieving a Specific Option With Option Group
Example: Retrieving Variant Specification Information for a Collection of Parts
Examples for the PTC CAD Document Management Domain
Retrieving a Specific CAD Document
Retrieving a Specific CAD Document with Expanded Navigation
Querying the CAD Document Using a Filter
Retrieving Related Parts Information for a Specific CAD Document
Retrieving References Information for a Specific CAD Document
Retrieving Source Information for a Specific Image CAD Document
Retrieving the CAD Structure using BOMMembersOnly Parameter
Examples for the PTC Effectivity Management Domain
Retrieving Effectivity Contexts
Retrieving Effectivities of a Part
Retrieving Block Effectivities of a Part
Retrieving Date Effectivities of a Part
Retrieving Unit Effectivities of a Part
Retrieving Effectivities on an Independent Assigned Expression
Example: Retrieving Effectivities of Specific Objects in a Set of Effectivity-managed Objects
Examples for the PTC Event Management Domain
Subscribing to an Event of a Windchill Object Instance
Subscribing to an Event of a Windchill Object Type in the Specified Container
Subscribing to an Event of a Windchill Object Type in the Specified Folder
Deleting a Subscription
Examples for the PTC Supplier Management Domain
Retrieving Sourcing Contexts
Retrieving Supplier, Manufacturer, and Vendor Parts
Retrieving AXLEntry for Parts
Filtering Parts Based on Sourcing Context and Sourcing Status Using Lambda Expression
Creating an AML Entry
Creating an AVL Entry
Updating an AXL Entry
Deleting an AXL Entry
Examples for the PTC Regulatory Master Domain
Retrieving Regulatory Submissions
Creating a Regulatory Submission
Examples for the PTC Reporting Domain
Example: Retrieving Report Templates
Example: Viewing the output of Report Template execution
Examples for the PTC Workflow Domain
Retrieving Work Items
Querying the Work Items Using a Filter
Retrieving the Routing Options for a Work Item
Retrieving the Subjects for Work Items
Completing a Work Item
Saving a Work Item
Retrieving the List of Valid Users to Reassign Work Items
Reassigning Work Items to Another User
Examples for the PTC UDI Domain
Retrieving UDI Super sets
Deleting details from a UDI Super Set
Adding Packaging Configurations to UDI Super Set
Updating Packaging Configurations in a UDI Super Set
Customizing Domains
Extending Domains
Adding Type Extensions of Windchill Types to PTC Domains
Adding Custom Properties to Entities in PTC Domains
Adding Custom Navigation Between Entities in PTC Domains
Adding New Functions to PTC Domains
Adding New Actions to PTC Domains
Creating New Domains
Examples for Customizing Domains
Creating a New Domain
Extending Product Management Domain to Add A Soft Type
Extending Document Management Domain to Add a Soft Attribute
Release Notes
Summary of Changes for Windchill REST Services 2.3
Summary of Changes for Windchill REST Services 2.2.1
Summary of Changes for Windchill REST Services 2.2
Summary of Changes for Windchill REST Services 2.1.1
Summary of Changes for Windchill REST Services 2.1
Summary of Changes for Windchill REST Services 2.0
Summary of Changes for Windchill REST Services 1.7
Summary of Changes for Windchill REST Services 1.6
Summary of Changes for Windchill REST Services 1.5
Summary of Changes for Windchill REST Services 1.4
Summary of Changes for Windchill REST Services 1.3
Summary of Changes for Windchill REST Services 1.2
Summary of Changes for Windchill REST Services 1.1
Version Changes in Domains
Version Changes in Domains for Windchill REST Services 2.3
Version Changes in Domains for Windchill REST Services 2.2
Version Changes in Domains for Windchill REST Services 2.1
Version Changes in Domains for Windchill REST Services 2.0
Version Changes in Domains for Windchill REST Services 1.7
Windchill REST Services 1.7
Version Changes in Domains for Windchill REST Services 1.6
Version Changes in Domains for Windchill REST Services 1.5
Version Changes in Domains for Windchill REST Services 1.4
Version Changes in Domains for Windchill REST Services 1.3
WRS OAuth Authentication
HTTP Status Codes Returned by Windchill REST Services Responses
Welcome to the Windchill Rest Services 2.3 Help Center
HTTP Status Codes Returned by Windchill REST Services Responses
d1e3153a1310