The filter parameter
filter=list_of_filter_criteria
You can focus on the data of your interest by adding a filter specification when requesting a list of values. You can use filters to specify the following:
- one or more name patterns to be matched against the names in the list
- a lower and upper bound to be compared to the values in a list
- a maximum list length with an indicator to select the instances with either the highest or the lowest values
- a sorting order for either the names or the values of the list (ascending or descending).
You can separate multiple filter criteria by a semicolon (“;”).
The following keywords are available for filters:
- PAT=<expression>
- Specifies one or more patterns which must match the name part of a list element.
- LB=<double>
- Specifies a lower bound value. That is, only list elements with values higher than the given lower bound are returned.
- UB=<double>
- Specifies an upper bound value. That is, only list elements with values lower than the specified upper bound are returned.
- HI=<integer>
- Only the highest <integer> list elements are returned (mutually exclusive with LO). The default is 20.
- LO=<integer>
- Only the lowest <integer> list elements are returned (mutually exclusive with HI).
- ORD=<xx>
- Sort the list of name/value pairs by their names in ascending (NA) or descending (ND) order (<xx>=NA or ND), or by their values in ascending (VA) or descending (VD) order. The default is VD. If you do not want to have any sort order, specify ORD=NN.
&filter=HI=20;ORD=VD which returns the top 20 values, sorted by value, in
descending order (VD).Examples:
| Filter term | Result |
|---|---|
| &filter=PAT=*CICS*|*SH* | only instances containing the name patterns CICS®, SH, or both are returned |
| &filter=LB=10.5 | only instances with a value higher than 10.5 are returned |
| &filter=UB=12.8 | only instances with a value lower than 12.8 are returned |
| &filter=HI=5 | only the instances containing the five highest values are returned |
| &filter=LO=5 | only the instances containing the five lowest values are returned |
| &filter=ORD=NA | specifies that the returned instances should be sorted by name in ascending order |