PTC Navigation Criteria Domain
The PTC Navigation Criteria domain provides access to the filters available in a part structure in Windchill. The filters are divided into two categories, configuration specifications that display a complete bill of material, and specialized filters that show a subset of parts relevant to a design task. The following table shows the Windchill items that are enabled with OData entities in the PTC navigation Criteria domain.
The following table lists the significant OData entities available in the PTC Navigation Criteria domain. To see all the OData entities available in the PTC Navigation Criteria domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL.
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Saved filters or navigation criteria in Windchill
|
NavigationCriteria
|
The NavigationCriteria entity represents filters, which are created and saved in Windchill. The criteria defined in the filter is used when you work with product structures.
To define the filter criteria, specify and save values in the filter. The values specified in the filter are access-controlled as is NavigationCriteria.
The entity includes complex types that represent different types of configuration specifications, spatial, option, and attribute filters.
|
In addition to the entity, this domain also contains the following complex types:
• ConfigSpec—Collection of configuration specifications in a part and CAD document structure. A configuration specification filters the part or CAD document structure to show complete product configurations with a part and document version displayed for each structure node.
 |
If ConfigSpec is not specified for CAD documents, then no configuration specification is used, and all the children are unresolved. The document masters are returned for the CAD documents.
|
The configuration specification filters are represented as the following complex types:
◦ Date Effectivity configuration specification—View the configuration of a product based on a specified date, or date and time effectivity. This filter is available only for parts. Use the WTPartEffectivityDateConfigSpec complex type to work with parts.
◦ As Matured configuration specification—View the parts that are in their most mature state with reference to the specified date. This filter is available only for parts. Use the WTPartAsMaturedConfigSpec complex type to work with parts.
◦ Unit Effectivity configuration specification—View the configuration of a product based upon the serial number or lot number. This filter is available only for parts. Use the WTPartEffectivityUnitConfigSpec complex type to work with parts.
◦ Baseline configuration specification—Get the design from a specific event in time, that is, from a previously created baseline. Depending on the type of Windchill object use the following complex types:
▪ WTPartBaselineConfigSpec—To work with parts.
▪ EPMDocBaselineConfigSpec—To work with CAD documents.
◦ Promotion Request configuration specification—Get the data related to the specified promotion request. Depending on the type of Windchill object use the following complex types:
▪ WTPartPromotionNoticeConfigSpec—To work with parts.
▪ EPMDocPromotionNoticeConfigSpec—To work with CAD documents.
◦ Latest configuration specification—Find the latest designs, that is, the most recently created versions of a selected view and life cycle state. Depending on the type of Windchill object use the following complex types:
▪ WTPartStandardConfigSpec—To work with parts.
▪ EPMDocStandardConfigSpec—To work with CAD documents.
|
|
If you specify the navigation criteria in the request body with only ApplicableType parameter set, the URL returns unresolved dependents for the CAD structure. However, if additionally, the UseDefaultForUnresolved parameter is also set to true in the request body, then Latest configuration specification is applied to the structure.
|
◦ As Stored configuration specification—Get the most recent configuration stored for a CAD document. This filter is available only for CAD documents. Use the EPMDocAsStoredConfigSpec complex type to work with CAD documents. If this filter is used with other Windchill object types, an error message is returned.
• Filter—Collection of specialized filters in a part structure. The specialized part structure filters reduce the complexity of the part structure by showing only those parts that are relevant to a design task or optional product configuration. The specialized filters are represented as the following complex types:
◦ AttributeFilter—Attribute filters use part and usage link attribute information to determine what parts to include or exclude in the display of part structure.
◦ OptionFilter—Option filter is used to include or exclude parts in a part structure based on expressions assigned to the parts.
◦ SpatialFilter—Spatial filters use volumetric information to determine what components to display or hide in a part or CAD document structure. It is represented by following complex types:
▪ ProximitySpatialFilter
▪ SphereSpatialFilter
▪ BoxSpatialFilter
◦ PathFilter—Filters the display of large assemblies so that only the subassemblies that you are currently working on are displayed.
◦ OccurrencePathFilter—Filters the display based on basic or advanced expressions assigned to an occurrence.
◦ UsagePathFilter—Filters the display based on expressions assigned to usage links and parts.
If you have a spherical spatial filter with bounding box set as partial, the navigation criteria for this is represented as shown below in Windchill REST Services. Use the following URL to retrieve the navigation criteria:
GET /Windchill/servlet/odata/NavCriteria/NavigationCriterias?$filter=Name eq 'Sphere_filter001'
The response is as follows:
"value": [
{
"ID": "OR:wt.filter.NavigationCriteria:261602",
"Name": "Sphere_filter001",
"ApplyToTopLevelObject": true,
"UseDefaultForUnresolved": false,
"SharedToAll": false,
"ApplicableType": "wt.part.WTPart",
"Centricity": false,
"HideUnresolvedDependents": false,
"Filters": [
{
"@odata.type": "#PTC.NavCriteria.SphereSpatialFilter",
"SpatialMethod": {
"Value": "PARTIALLY_IN",
"Display": "Partially in"
},
"XCenter": -0.5334005391706416,
"YCenter": 0.0503675,
"ZCenter": 0.00136,
"Radius": 0.40648001432418823
"Unit": "m"
}
],
"ConfigSpecs": [
{
"@odata.type": "#PTC.NavCriteria.WTPartStandardConfigSpec",
"WorkingIncluded": true,
"View": "Design",
"LifeCycleState": null,
"Variation1": null,
"Variation2": null
}
],
"CreatedOn": "2018-10-01T11:38:16Z",
"LastModified": "2018-10-01T11:38:16Z"
}
]
}
{
"ID": "OR:wt.filter.NavigationCriteria:261602",
"Name": "Sphere_filter001",
"ApplyToTopLevelObject": true,
"UseDefaultForUnresolved": false,
"SharedToAll": false,
"ApplicableType": "wt.part.WTPart",
"Centricity": false,
"HideUnresolvedDependents": false,
"Filters": [
{
"@odata.type": "#PTC.NavCriteria.SphereSpatialFilter",
"SpatialMethod": {
"Value": "PARTIALLY_IN",
"Display": "Partially in"
},
"XCenter": -0.5334005391706416,
"YCenter": 0.0503675,
"ZCenter": 0.00136,
"Radius": 0.40648001432418823
"Unit": "m"
}
],
"ConfigSpecs": [
{
"@odata.type": "#PTC.NavCriteria.WTPartStandardConfigSpec",
"WorkingIncluded": true,
"View": "Design",
"LifeCycleState": null,
"Variation1": null,
"Variation2": null
}
],
"CreatedOn": "2018-10-01T11:38:16Z",
"LastModified": "2018-10-01T11:38:16Z"
}
]
}