About Data-Driven REST Web Services › Filter on Attributes in the XSD Schema for Data-Driven REST Web Services

Filter on Attributes in the XSD Schema for Data-Driven REST Web Services

You can filter on attributes such as the item name, description and other such attributes. For example, filter monitoring profiles by the metric families they contain. You can use this information to determine whether to add or remove metric families to or from a monitoring profile.

Follow these steps:

1. Enter the following URL in a web browser:

   http://hostname:port/rest/
   

   A list displays the available data-driven web services.

2. Click a web service.

   The documentation page for that web service displays.

3. Click the URL under the "filtered get list" method.

   The XSD schema opens.

4. Look for the elements that have substitutionGroup="AttributeFilterTypeSubstitution", as shown in the following example. Use this information to determine which attribute you want to filter on.

   

5. Open a REST client editor or HTTP tool that sends requests and gets responses, and set the Content-type to application/xml.
6. Enter the following filter criteria:
   • URL: http://hostname:port/rest/endpoint/filtered/
   • HTTP method = POST

     This method must define the filter criteria.

   • Basic filter select criteria on the Body tab in the HTTP Request pane:

     <FilterSelect xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="filter.xsd">
            <Filter>
                        <elementName type="CONTAINS">filter-criteria</elementName>
            </Filter>
     </FilterSelect>
     

     filter-criteria

     Specifies the actual value of the attribute.

     elementName

     Specifies the element name (attribute) to filter on.

     Note: You can specify selection criteria also, such as poll rates only. This method is also known as Get Tunneling. For more information, see the following example.

   Results are returned in the Body tab of the HTTP Response pane.

Example: Return a List of Monitoring Profiles that Contain a Metric Family Using Filter and Selection Criteria (Get Tunneling).

Enter the following URL to return the monitoring profiles that contain a metric family using poll rate as the selection criteria:

• Method and URL:

  POST http://hostname:port/rest/monitoringprofiles/filtered/
  

• Body:

  <FilterSelect xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="filter.xsd">
                  <Filter>
                         <MonitoringProfile.FacetTypes type="CONTAINS">{http://im.ca.com/normalizer}NormalizedPortInfo</MonitoringProfile.FacetTypes>
                  </Filter>
                  <Select use="exclude"  isa="exclude">
                     <MonitoringProfile use="exclude"> 
                         <PollRate use="include"/>
                     </MonitoringProfile>       
                  </Select>
  </FilterSelect>
  

The following graphic reflects the preceding example. The response shows the monitoring profiles that contain the NormalizedPortInfo metric (filter criteria), and these profiles only contain the specified PollRate attribute (selection criteria).