GetTestsRequest

This element is sent in an invocation of the GetTests or GetTestsEx operation.

Derived by

Restricting anyType

Content model

Contains elements as defined in the following table.

Component 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.

Example

In this example, the optional test filter is omitted:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
</prov:GetTestsRequest>

This example is filtered by AgentType:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>My_Username</prov:UserName>
      <prov:Password>My_Password</prov:Password>
   </prov:Credentials>
   <prov:MonitorFilter>
      <prov:AgentType>FF</prov:AgentType>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by monitor group (folder name):

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:MonitorFilter>
      <prov:Group>TestManagement, MultiStepTests</prov:Group>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by test status:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:MonitorFilter>
      <prov:MonitorStatus>Active</prov:MonitorStatus>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by monitor ID:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <prov:MonitorFilter>
      <prov:MonitorId>326334</prov:MonitorId>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by create date:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:MonitorFilter>
      <prov:QueryByCreateDate dateQueryType=
        "GreaterThan" queryDate="2012-11-07T01:00:00"/>
      <prov:QueryByCreateDate dateQueryType=
        "LessThanOrEqualTo" queryDate="2012-11-07T23:59:00"/>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by modify date:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:MonitorFilter>
      <prov:QueryByModifyDate dateQueryType=
        "GreaterThan" queryDate="2012-08-05T10:17:12"/>
      <prov:QueryByModifyDate dateQueryType=
        "LessThanOrEqualTo" queryDate="2012-08-10T10:17:12"/>
   </prov:MonitorFilter>
</prov:GetTestsRequest>

This example is filtered by expiration date:

<prov:GetTestsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>EricSmith</prov:UserName>
      <prov:Password>EricSmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:MonitorFilter>
      <prov:QueryByExpirationDate dateQueryType=
        "GreaterThan" queryDate="2012-08-05T10:17:12"/>
      <prov:QueryByExpirationDate dateQueryType=
        "LessThanOrEqualTo" queryDate="2012-08-10T10:17:12"/>
   </prov:MonitorFilter>
</prov:GetTestsRequest>