Windchill REST Services OData Properties

Windchill REST Services > Windchill REST Services Framework Capabilities > Support for OData > Windchill REST Services OData Properties

The OData properties control the core WRS framework behavior related to OData specifications. You can set properties in the odata.properties file located in <WT_HOME>/codebase/com/ptc/odata/core/odata.properties.

Restart the MethodServer after modifying any odata.properties.

maxPageSize

Default	2000
Synopsis	Configures the maximum page size value while making a request in odata.properties.
Description	The default value for maxPageSize is 2000. However, it can be set to any value, up to a maximum of 100000. The odata.maxpagesize value specified in Prefer header, while making a request, overrides the defaultPageSize value.

defaultPageSize

Default	25
Synopsis	Configures the default page size value while making a request in odata.properties.
Description	The default value for defaultPageSize is 25. Once the value is set, it should be applied to all WRS endpoints that support pagination. The odata.maxpagesize value specified in Prefer header while making a request, overrides the defaultPageSize value.

useCachedJavaScript

Default	true
Synopsis	Improves performance by using cached JavaScript files. When implementing customizations, the property can be set to false for JavaScript changes to take effect without restarting Windchill.
Description	When implementing customizations, set the property to false for JavaScript changes to take effect without restarting Windchill.

expandMaxLevel

Default

Synopsis

Configures max level ($levels=max) for expand.

Description

Provides ability to configure max level ($levels=max) for expand.

If client requests for max value greater than expandMaxLevel value, then it will return an error “The levels to expand specified in $levels parameter exceeds the maximum allowed value of expandMaxLevel”.

allowDuplicateNavigation

Default	false
Synopsis	Allows duplicate navigation properties in $expand.
Description	When allowDuplicateNavigation is true, it allows URLs with duplicate navigation properties in $expand, even though this does not comply with OData specifications. The default value is false. We recommended that you keep it as false unless it causes issues with an existing client.

edmCacheSize

Default	90
Synopsis	Specifies the size of the EDM cache.
Description	Each domain version accessed by a client counts toward this limit. Consider increasing this value if you see warnings in the MethodServer logs.

Was this helpful?