Administration > OData Web Services > Compliance Matrix for OData
  
Compliance Matrix for OData
Protocol
Use the following matrix to determine supported and unsupported protocol in OData for PTC FlexPLM:
Item
Description
Support
Comment
5
Versioning
5.1
Protocol Versioning
Supported
Only OData version 4 is supported.
5.2
Model Versioning
Supported
6
Extensibility
6.1
Query Option Extensibility
Supported
6.2
Payload Extensibility
Supported
6.3
Action/Function Extensibility
Supported
6.4
Vocabulary Extensibility
Supported
6.5
Header Field Extensibility
Supported
Exception is a custom header for security purposes (Cross site request forgery nonce key).
6.6
Format Extensibility
Supported
7
Formats
8
Header Fields
8.1
Common Headers
8.1.1
Header Content-Type
Supported
8.1.2
Header Content-Encoding
Supported
8.1.3
Header Content-Language
Not supported
8.1.4
Header Content-Length
Not supported
8.1.5
Header OData-Version
Supported
Only OData version 4 is supported.
8.2
Request Headers
8.2.1
Header Accept
Supported
8.2.2
Header Accept-Charset
Not supported
8.2.3
Header Accept-Language
Not supported
8.2.4
Header If-Match
Not supported
8.2.5
Header If-None-Match
Not supported
8.2.6
Header OData-Isolation
Not supported
8.2.7
Header OData-MaxVersion
Supported
Only OData version 4 is supported.
8.2.8
Header Prefer
Not supported
8.3
Response Headers
8.3.1
Header ETag
Not supported
8.3.2
Header Location
Not supported
8.3.3
Header OData-EntityId
Not supported
Create or upsert operation returns either 200 OK or 201 Created.
8.3.4
Header Preference-Applied
Not supported
8.3.5
Header Retry-After
Not supported
9
Common Response Status Codes
9.1
Success Responses
9.1.1
Response Code 200 OK
Supported
9.1.2
Response Code 201 Created
Supported
9.1.3
Response Code 202 Accepted
Not supported
9.1.4
Response Code 204 No Content
Supported
9.1.5
Response Code 3xx Redirection
Not supported
9.1.6
Response Code 304 Not Modified
Not supported
9.2
Client Error Responses
9.2.1
Response Code 404 Not Found
Supported
9.2.2
Response Code 405 Method Not Allowed
Not supported
9.2.3
Response Code 410 Gone
Not supported
9.2.4
Response Code 412 Precondition Failed
Not supported
9.3
Server Error Responses
9.3.1
Response Code 501 Not Implemented
Supported
9.4
In-Stream Errors
Not supported
10
Context URL
10.1
Service Document
Supported
10.2
Collection of Entities
Supported
10.3
Entity
Supported
10.4
Singleton
Not supported
10.5
Collection of Derived Entities
Supported
10.6
Derived Entity
Supported
10.7
Collection of Projected Entities
Supported
10.8
Projected Entity
Supported
10.9
Collection of Projected Expanded Entities
Not supported
10.10
Projected Expanded Entity
Not supported
10.11
Collection of Entity References
Supported
10.12
Entity Reference
Supported
10.13
Property Value
Not supported
10.14
Collection of Complex or Primitive Types
Not supported
10.15
Complex or Primitive Type
Not supported
10.16
Operation Result
Not supported
10.17
Delta Response
Not supported
10.18
Item in a Delta Response
Not supported
10.19
$all Response
Not supported
10.20
$crossjoin Response
Not supported
11
Data Service Requests
11.1
Metadata Requests
11.1.1
Service Document Request
Supported
11.1.2
Metadata Document Request
Supported
11.1.3
Metadata Service Document Request
Supported
11.2
Requesting Data
11.2.1
Requesting Individual Entities
Supported
11.2.2
Requesting the Media Stream of a Media Entity
Not supported
11.2.3
Requesting Individual Properties
Not supported
11.2.4
Specifying Properties to Return
11.2.4.1
System Query Option $select
Supported
11.2.4.2
System Query Option $expand
Not supported
11.2.5
Querying Collections
11.2.5.1
System Query Option $filter
11.2.5.1.1
Built-in Filter Operations
Partial
The following are supported: eq, ne, gt, ge, lt, le, and, or
11.2.5.1.2
Built-in Query Functions
Not supported
11.2.5.1.3
Parameter Aliases
Not supported
11.2.5.2
System Query Option $orderby
Supported
11.2.5.3
System Query Option $top
Supported
11.2.5.4
System Query Option $skip
Supported
11.2.5.5
System Query Option $count
Supported
11.2.5.6
System Query Option $search
Not supported
11.2.5.7
Server-Driven Paging
Not supported
11.2.6
Requesting Related Entities
Not supported
11.2.7
Requesting Entity References
Not supported
11.2.8
Resolving an Entity-Id
Not supported
11.2.9
Requesting the Number of Items in a Collection
Not supported
$count is supported as query parameter expressed in item 11.2.5.5.
11.2.10
System Query Option $format
Not supported
11.3
Requesting Changes
11.3.1
Delta Links
Not supported
11.3.2
Using Delta Links
Not supported
11.4
Data Modification
11.4.1
Common Data Modification Semantics
11.4.2
Create an Entity
Supported
11.4.2.1
Link to Related Entities When Creating an Entity
Not supported
11.4.2.2
Create Related Entities When Creating an Entity
Not supported
11.4.3
Update an Entity
Supported
11.4.4
Upsert an Entity
Supported
Update on an invalid OID fails.
11.4.5
Delete an Entity
Supported
11.4.6
Modifying Relationships between Entities
Not supported
11.4.7
Managing Media Entities
Not supported
11.4.8
Managing Stream Properties
Not supported
11.4.9
Managing Values and Properties Directly
Not supported
11.5
Operations
Not supported
12
Security Considerations
12.1
Authentication
Support
See the relevant Windchill manual for supported authentication methods.
URL Conventions
Use the following matrix to determine supported and unsupported URL conventions in OData for PTC FlexPLM:
Item
Description
Support
Comment
4
Resource Path
4.1
Addressing the Model for a Service
Supported
4.2
Addressing the Batch Endpoint for a Service
Not supported
4.3
Addressing Entities
Supported
4.3.1
Canonical URL
Supported
4.3.2
Canonical URL for Contained Entities
Not supported
4.3.3
URLs for Related Entities with Referential Constraints
Not supported
4.3.4
Resolving an Entity-Id
Not supported
4.4
Addressing References between Entities
Not supported
4.5
Addressing Operations
Not supported
4.5.1
Addressing Actions
Not supported
4.5.2
Addressing Functions
Not supported
4.6
Addressing a Property
Not supported
4.7
Addressing a Property Value
Not supported
4.8
Addressing the Count of a Collection
Not supported
4.9
Addressing Derived Types
Supported
4.10
Addressing the Media Stream of a Media Entity
Not supported
4.11
Addressing the Cross Join of Entity Sets
Not supported
4.12
Addressing All Entities in a Service
Not supported
5
Query Options
5.1
System Query Options
5.1.1
System Query Option $filter
Partial
5.1.1.1
Logical Operators
Partial
All operators supported except Not (5.1.1.1.9) and Has (5.1.1.1.10).
5.1.1.2
Arithmetic Operators
Not supported
5.1.1.3
Grouping
Not supported
5.1.1.4
Canonical Function
Not supported
5.1.1.5
String Functions
Not supported
5.1.1.6
Date and Time Functions
Not supported
5.1.1.7
Arithmetic Functions
Not supported
5.1.1.8
Type Functions
Not supported
5.1.1.9
Geo Functions
Not supported
5.1.2
System Query Option $expand
Not supported
5.1.3
System Query Option $select
Supported
5.1.4
System Query Option $orderby
Supported
5.1.5
System Query Options $top and $skip
Supported
5.1.6
System Query Option $count
Supported
5.1.7
System Query Option $search
Not supported
5.1.8
System Query Option $format
Not supported
5.2
Custom Query Options
Not supported
5.3
Parameter Aliases
Not supported