OData Query Parameters
Windchill Risk and Reliability REST Services supports most of the query parameters from the OData standard listed in Requesting Data. A few parameters are as described in the following table.
|
Query Parameter
|
Description
|
||
|---|---|---|---|
|
$filter
|
Filter the entities in a collection. Write an expression to display entities that result in a true value. OData supports filter expressions for all primitives.
Windchill Risk and Reliability REST Services supports this query parameter on navigation properties. See the Support for $filter on Navigation Properties section for more details.
|
||
|
Example:
Project_<projectID>/ListLibraries(<listlibraryID>)/ListDefinitions(<listdefinitionID>)/ListChoices?$filter=Hidden eq false
Filters hidden ListChoices.
|
|||
|
$select
|
Show a comma-separated list of entity properties. For example, in the URL you can list the FMEA attributes such as, FMEAType and FMEAIdentifier, to display only the FMEA Type and FMEA identifier of the FMEA.
|
||
|
Example:
Project_<<projectID>>/Systems(<systemID>)/Configurations(<configurationID>)/SystemTreeItems?$select=ID,ParentID,SystemTreeIdentifier
Selects SystemTreeItems navigation to only show ID, ParentID, and SystemTreeIdentifier.
|
|||
|
$expand
|
Show related resources, alongside retrieved resources, in a comma-separated list of navigations.
|
||
|
Example:
/Project_<projectID>/Systems(<systemID>)/FMEAs(<fmeaID>)?$expand=Configuration($select=ID),TreeItems
Expands TreeItems and Configuration navigation to only show ID properties of Configuration entities and all properties of FMEATreeItem entities.
/Project_<projectID>/Systems(<systemID>)/FMEAs?$expand=TreeItems($select=ID,SystemTreeIdentifier)
Expands TreeItems navigation to only show ID and SystemTreeIdentifier properties of FMEATreeItems entities.
|
|||
|
$top
|
Show the first N entities in a collection.
|
||
|
Example:
/Project_<projectID>/Systems(<systemID>)/Incidents?$filter=SerialNumber gt '1'&$top=2
Shows the top two Incidents entities, with a Serial Number greater than one, from a collection of Incident entities.
|
|||
|
$skip
|
Skip the first N number of entities in a collection, and display the set of entities as N+1 onward.
|
||
|
Example:
/Project_<projectID>/Systems(<systemID>)/Incidents?$skip=2
skips the top two Incidents entities, from a collection of Incident entities.
|
|||
|
$orderby
|
Sorts entities in ascending and descending order. The query parameter is supported for Primitive attributes—String, Boolean, Integer, Real Number (Double), Date, and Time types.
|
||
|
Example:
/Project_(<projectID>)/Graphs?$orderby=ProductModuleName
Sorts Graphs entities in ascending order of ProductModuleName.
/Project_(<projectID>)/Graphs?$orderby=ProductModuleName,Name
Sorts Graphs entities in ascending order of ProductModuleName on which they were created, and then by Name:
|
|||
|
$count
|
Show the number of items in a collection. When including this parameter in a URL, specify the value as either true or false. If you do not specify any value, you will get an error message.
The count is returned in the response body as "@odata.count": <count_value>.
The following URLs support $count:
• Direct entities
• Navigation properties
• Expanded navigation properties
|
||
|
Example:
ProjectMgmt/Projects?$count=true
Returns the $count of all the projects available on the server.
|
The following query parameters are not supported by Windchill Risk and Reliability REST Services.
• totaloffsetminutes
• now
• mindatetime
• maxdatetime
• has
• search
Use the above query parameters when you:
• Access entity sets defined in the domain.
• Navigate to a collection of entities from a given entity.
• Expand navigation properties of entities.