Windchill REST Services > Windchill REST Services Framework Capabilities > Windchill REST Services Properties
Windchill REST Services Properties
The WRS properties control the WRS behavior. To change the properties, the wrs.properties.xconf file should not be directly updated. For updating the property file refer to Manipulating Property Files.You can set properties in the wrs.properties.xconf file located in WT_HOME/codebase/com/ptc/odata/windchill.
* 
Do not modify the OOTB configuration file directly. Instead, create a custom XCONF file and declare the file in the declarations.xconf or site.xconf file. Alternatively, you can manage the XCONF file in wtSafeArea or use the xconfmanager -s command to set the property in site.xconf.
multipleValuesInStringDelimiter
Default
|
Synopsis
Defines the delimiter used in PTC.MultipleAliasAttributeValues and PTC.MultipleCalculatedAttributeValues annotations.
Description
This is used only for entities with softAttributable version 4 and earlier. The softAttributable version 5 and later no longer use the annotation. For more information, see Version Changes in Domains for Windchill REST Services 2.6 and PTC Annotations.
disableAuthenticatedContentUrl
Default
false
Synopsis
Indicates whether the link requires authentication (default) or just a signed token (old behavior) for content download links.
Description
When set to false, the link requires authentication for content download links.
When set to true, the link requires a signed token (old behavior) for content download links.
* 
It is recommended to keep the default behavior and use authenticated URLs when downloading content.
disableCommonPropertyValidation
Default
false
Synopsis
Controls PATCH requests to update the Common properties.
Description
When set to true, allows PATCH requests to update the Common properties.
* 
The properties marked as Common must be updated using the UpdateCommonProperties action.
disableSecureInfoProcessingOnProperties
Default
false
Synopsis
Controls the addition of the PTC.AccessException annotation to a property.
Description
When set to false, adds the PTC.AccessException annotation to a property if the user has insufficient permissions.
When set to true, disables the second-pass processing during serialization. Therefore, the PTC.AccessException annotation will not be present in the response. It improves performances in some circumstances. When the property is set to true, it does not pose any security risk and does not affect access control.
* 
While it can improve performances, the client will not be able to know whether the property is null because it is not accessible or because it has no value.
asynchronousResponseCleanupInterval
Default
10 minutes
Synopsis
Controls the frequency of deleting the stale asynchronous responses.
Description
Provides ability to control the frequency of deleting the stale asynchronous responses. You can adjust the clean-up interval to suit your system usage.
allowedPreferencesForEdmCacheReset
Default
Display_OrgID, Display_OrgID_SUMA, Display_Change_Mgmt_Objects_OrgID, ENABLE_CONFIGURABLE_PARTS
Synopsis
Comma-delimited list of preference keys that are allowed to reset the Entity Data Model cache.
Description
Comma-delimited list of preference keys that are allowed to reset the Entity Data Model cache. For more information, see Entity Data Model of a Domain.
* 
EDM should be reset when the Expose Organization preference is updated.
renameDuplicateProperties
Default
true
Synopsis
Prevents conflicts between a new custom attribute and an out-of-the-box (OOTB) property name by appending “Duplicate” to the custom property name.
Description
When a generated custom property results in a naming conflict with an existing property, including structural or navigation properties, Windchill REST Services resolves the conflict by renaming the generated property.
If renameDuplicateProperties=true, the generated property name is updated by appending Duplicate. Conflicts are detected across the entity type hierarchy, including parent, child, and descendant entity types.
For example, if you define a custom attribute with the internal name LastModified on WTPart, and an out‑of‑the‑box property named LastModified already exists on PTC.WindchillEntity, the generated property is renamed to LastModifiedDuplicate.
* 
When a structural or navigation property defined in an entity JSON results in a naming conflict, the property will not be renamed; instead, it will result in a configuration error when you access the metadata of the domain in which the property is defined. Contact PTC Technical Support if you encounter a configuration error while accessing the metadata of a domain.
* 
If you have a custom structural property with the same name as an OOTB navigation property, such as "Context", refer to the Extending Document Management Domain to Add a Soft Attribute topic. Follow the steps given here to add your custom attribute using a different property name.
* 
You can disable this new behavior by setting renameDuplicateProperties=false in wrs.properties.xconf. However, this may lead to unexpected behavior. It is recommended keep this property set to true.
enableEdmCacheByOrganization
Default
true
Synopsis
Controls whether the Entity Data Model (EDM) is cached per organization to ensure isolation in multi‑organization environments.
Description
When set to true (default), the EDM is cached separately for each organization. This ensures proper EDM isolation in multi‑organization deployments. The list of organizations applicable for the EDM is shown in the PTC.OrganizationContexts annotation when accessing the metadata for a domain.
When set to false, EDM caching is not performed per organization.
This configuration is recommended only for single‑organization deployments to avoid unnecessary caching overhead and improve system performance.
replaceWithWorkingCopiesInEntitySetResults
Default
true
Synopsis
Controls whether WRS replaces original copies with their corresponding working copies in entity set results.
Description
When set to true (default), returns working copies that the user has access to instead of original copies
When set to false, does not return working copies and behaves similarly to Advanced Search.
* 
$filter and $orderby always apply to the original copies, regardless of the value of the property.
Was this helpful?