Filtering
The RestAPI includes
the following Keys that can be used to filter large namespace collections:
- filterRules
- maxCount
The following call shows how the filterRules
element can be used to filter large collections. In this example,
only tags containing the letters “BA:” will be returned:
{"fqn":"Historians.appserhist" ,
"propNames": ["fqn", "childCount", "type"] , "filterRules": [{"fqn":"BA:"}] } |
In the following example, only tags containing
either BA:Conc or BA:Active will be returned:
{"fqn":"Historians.appserhist" ,
"propNames": ["fqn", "childCount", "type"] , "filterRules": [{"fqn":"BA:Conc"},{"fqn":"BA:Active"}] } |
Finally, the following call shows the use of
the maxCount key to limit the result to 10 items. The maxCount and
filterRules keys can be used in conjunction. When used together,
the maxCount filter is applied to the result returned after the
filterRules filter has been applied.
{"fqn":"Historians.appserhist" ,
"propNames": ["fqn", "childCount", "type"] , "maxCount": 10 } |
Provide Feedback