Get the list of all tests for an account (GetTests, GetTestsSummary)

For this use case, you want to see all the tests that have been created for your account. To do this, you only have to submit your portal credentials. The API provides two different queries for this purpose:

  • A GetTests() query that contains detailed information about each test (not only the parameters used to create the test but also the list of steps for each test. A step corresponds to a single address on the web (a URL, a display name and a step sequence number).

  • A GetTestsSummary() that returns only some test parameters but no step information. This query will provide better performance if the number of tests under a single account is large.

Sample GetTests query

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <soapenv:Header/>
   <soapenv:Body>
      <prov:GetTestsRequest>
         <prov:Credentials>
            <prov:UserName>MyUser</prov:UserName>
            <prov:Password>MyPassword</prov:Password>
         </prov:Credentials>
      </prov:GetTestsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Sample GetTests response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetTestsResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <Monitors>
            <Monitor name="Site Management Test SingleStepMonitor 1"
                     folder="Site Management Tests"
                     agentType="IE"
                     summaryFlag="On"
                     includeRenderTimeFlag="On"
                     frequencyInMins="60"
                     expirationDate="2012-07-20T10:17:12"
                     ipVersion="IPv4_only"
                     monitorStatus="Inactive"
                     folderStatus="Active"
                     monitorId="263756"
                     createDate="2012-07-19T14:17:11.953"
                     modifyDate="2012-07-21T00:05:00.583"
                     scriptId="263756">
               <MonitorSites>
                  <MonitorSite siteId="865"/>
                  <MonitorSite siteId="866"/>
                  <MonitorSite siteId="873"/>
                  <MonitorSite siteId="880"/>
                  <MonitorSite siteId="886"/>
               </MonitorSites>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.dynatrace.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Monitor>
            <Monitor name="Site Management Test SingleStepMonitor 2"
                     folder="Site Management Tests"
                     agentType="IE"
                     summaryFlag="On"
                     includeRenderTimeFlag="Off"
                     frequencyInMins="60"
                     expirationDate="2012-07-20T10:17:14"
                     ipVersion="IPv4_only"
                     monitorStatus="Inactive"
                     folderStatus="Active"
                     monitorId="263757"
                     createDate="2012-07-19T14:17:14.66"
                     modifyDate="2012-07-21T00:05:00.583"
                     scriptId="263757">
               <MonitorSites>
                  <MonitorSite siteId="865"/>
                  <MonitorSite siteId="866"/>
                  <MonitorSite siteId="873"/>
                  <MonitorSite siteId="880"/>
                  <MonitorSite siteId="886"/>
               </MonitorSites>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.dynatrace.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Monitor>
         </Monitors>
      </GetTestsResponse>
   </soap:Body>
</soap:Envelope>

Sample GetTestsSummary query

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

Sample GetTestsSummary response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetTestsSummaryResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <MonitorSummaries>
            <MonitorSummary monitorId="263717"
                            description="Updated Original Name"
                            status="Active"
                            frequencyInMins="60"
                            summaryFlag="Off"
                            createDate="2012-07-19T14:14:18"
                            modifyDate="2012-07-31T19:02:11"
                            ipVersion="IPv4_only"/>
            <MonitorSummary monitorId="263733"
                            description="MultiStepTest 7/19/2012 10:15:24 AM"
                            status="Active"
                            frequencyInMins="5"
                            summaryFlag="Off"
                            createDate="2012-07-19T14:15:14"
                            modifyDate="2012-08-08T18:56:16"
                            ipVersion="IPv4_only"/>
            <MonitorSummary monitorId="293255"
                            description="SingleStepTest 8/14/2012 1:28:22 PM"
                            status="Active"
                            frequencyInMins="60"
                            summaryFlag="Off"
                            createDate="2012-08-14T17:28:25"
                            modifyDate="2012-08-14T17:28:28"
                            ipVersion="IPv4_only"/>
            <MonitorSummary monitorId="293256"
                            description="Test 08-14-2012 MyUser 002"
                            status="Active"
                            frequencyInMins="60"
                            summaryFlag="Off"
                            createDate="2012-08-14T19:41:47"
                            modifyDate="2012-08-14T19:41:47"
                            ipVersion="IPv4_only"/>
         </MonitorSummaries>
      </GetTestsSummaryResponse>
   </soap:Body>
</soap:Envelope>