GetTests

This web method returns all the browser tests, active or inactive, under a qualified account. A MonitorFilter can be sent with the request to restrict the output.

Action

http://gpn.webservice.gomez.com/TestManagementWS_30/TestManagementService.asmx?op=GetTests

Style

Document

Input (literal)

This message contains a single GetTestsRequest defining one or more monitor orders (SingleStepMonitors or MultiStepMonitors).

Element Type Occurs Nillable? Description
SEQUENCE   1..1    
Credentials anyType (restriction) 1..1 No A Credentials element contains the username and password of an account user. The element is required in all requests to the Test Management Web Service.
UserName [element Credentials] string 1..1 No The UserName of an employee for an account (and used for authentication).
Password [element Credentials] string 1..1 No A secret used as part of user credentials for authentication. Every request to the Test Management API web service must include a Credentials element. That element itself contains a UserName and a Password element.
MonitorFilter FilterBase 0..1 No A MonitorFilter is used in a GetTests operation invocation to restrict the output of the query.
AgentType [type FilterBase] AgentType 0..1 Yes If present, this element restricts the output of GetTests() or GetScripts() by agent type.
QueryByCreateDate [type FilterBase] DateFilterType 0..* Yes QueryByCreateDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by create date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
QueryByModifyDate [type FilterBase] DateFilterType 0..* Yes QueryByModifyDate is supported in both ScriptFilters and MonitorFilters. If present, this element restricts the output by modify date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
MonitorId [element MonitorFilter] string 0..1 Yes If present, this element restricts the filter output to a specific browser test.
QueryByExpirationDate [element MonitorFilter] DateFilterType 0..* Yes If present, this element restricts GetTests() output by test expiration date. Multiple instances of this element are permitted so that both upper and lower bounds can be set.
MonitorStatus [element MonitorFilter] MonitorStatusType 0..1 No If present, this element restricts GetTests() output by MonitorStatus (Active or Inactive).
Group [element MonitorFilter] string 0..* Yes If present, this element restricts GetTests() output by membership in a particular monitor group (also called Folder). If multiple instances of Group are supplied, the tests in the output have to match ANY of them.

Output (literal)

This message contains a single GetTestsResponse defining one or more monitor order responses.

Element Type Occurs Nillable? Description
SEQUENCE   1..1    
ResponseStatus ResponseStatusType 1..1 No This element appears in most of the responses issued when the Test Management API operations are invoked.
ErrorMessage [type OperationResponseType] string 0..1 No The error message is provided if the ResponseStatus was FAILURE.
Monitors anyType (restriction) 1..1 No A Monitors element is a container of Monitor elements. It appears in a GetTests response and holds all the data that the query is expected to contain. It also appears in an UpdateTests request. There it contains all of the Monitor elements that are used to update the already provisioned tests.

Example

Request

<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>erics</prov:UserName>
            <prov:Password>erics</prov:Password>
         </prov:Credentials>
         <prov:MonitorFilter>
            <prov:AgentType>IE</prov:AgentType>
            <prov:QueryByCreateDate dateQueryType="LessThan"
              queryDate="2012-07-29T14:16:54"/>
            <prov:MonitorStatus>Inactive</prov:MonitorStatus>
         </prov:MonitorFilter>
      </prov:GetTestsRequest>
   </soapenv:Body>
</soapenv:Envelope>

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="Updated2 Name...Updated2 Name...
             Site Management Test SingleStepMonitor
             7/19/2012 10:14:18 AM" folder="Updated2 Folder"
             agentType="IE" summaryFlag="On"
             includeRenderTimeFlag="On" frequencyInMins="60"
             expirationDate="2012-07-20T10:14:18" ipVersion="IPv4_only"
             monitorStatus="Inactive" folderStatus="Active" monitorId="263717"
             createDate="2012-07-19T14:14:18.653" modifyDate=
             "2012-07-23T21:51:32.05" scriptId="263717">
               <MonitorSites>
                  <MonitorSite siteId="886"/>
                  <MonitorSite siteId="884"/>
                  <MonitorSite siteId="885"/>
                  <MonitorSite siteId="873"/>
                  <MonitorSite siteId="865"/>
                  <MonitorSite siteId="866"/>
                  <MonitorSite siteId="880"/>
               </MonitorSites>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.dynatrace.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Monitor>
            <Monitor name="Site Management Test SingleStepMonitor
             7/19/2012 10:14:25 AM" agentType="IE" summaryFlag="On"
             includeRenderTimeFlag="On" frequencyInMins="60"
             expirationDate="2012-07-20T10:14:25" ipVersion="IPv4_only"
             monitorStatus="Inactive" monitorId="263718"
             createDate="2012-07-19T14:14:25.513" modifyDate=
             "2012-07-21T00:05:00.583" scriptId="263718">
               <MonitorSites/>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.dynatrace.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Monitor>
            <Monitor name="Site Management Test SingleStepMonitor
             7/19/2012 10:14:29 AM" folder="Site Management Tests"
             agentType="IE" summaryFlag="On" includeRenderTimeFlag="On"
             frequencyInMins="60" expirationDate="2012-07-20T10:14:29"
             ipVersion="IPv4_only" monitorStatus="Inactive"
             folderStatus="Active" monitorId="263719" createDate=
             "2012-07-19T14:14:29.26" modifyDate=
             "2012-07-21T00:05:00.583" scriptId="263719">
               <MonitorSites/>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.dynatrace.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Monitor>
         </Monitors>
      </GetTestsResponse>
   </soap:Body>
</soap:Envelope>