Viewing substitution parameters for tests

You can use several methods to retrieve the substitution parameters for tests.

Viewing the substitution parameters for a single test

If you want to see the substitution parameter definitions for a single test, you may run the GetParameterizedTests() query with the following filter:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <soapenv:Header/>
   <soapenv:Body>
      <prov:GetParameterizedTestsRequest>
         <prov:Credentials>
            <prov:UserName>testuser</prov:UserName>
            <prov:Password>testpassword</prov:Password>
         </prov:Credentials>
         <prov:ParameterizedTestFilter>
            <prov:MonitorId>263717</prov:MonitorId>
         </prov:ParameterizedTestFilter>
      </prov:GetParameterizedTestsRequest>
   </soapenv:Body>
</soapenv:Envelope>

This query will only return results for monitor ID 263717 if that test has substitution parameters. The MonitorId element may only appear once in the ParameterizedTestFilter. It is not possible to send a list of monitor IDs.

Viewing substitution parameters for all active or inactive tests

To exclude the inactive tests from the results of a GetParameterizedTests() query, the request should look for this use case:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <soapenv:Header/>
   <soapenv:Body>
      <prov:GetParameterizedTestsRequest>
        <prov:Credentials>
            <prov:UserName>testuser</prov:UserName>
            <prov:Password>testpassword</prov:Password>
         </prov:Credentials>
         <prov:ParameterizedTestFilter>
            <prov:MonitorStatus>Active</prov:MonitorStatus>
         </prov:ParameterizedTestFilter>
      </prov:GetParameterizedTestsRequest>
   </soapenv:Body>
</soapenv:Envelope>

In such a query, MonitorStatus may be Active or in Inactive. In either case, the server will only return data for tests of the monitor status stated in the ParameterizedTestFilter.