GetScriptsRequest

A GetScriptsRequest is the message sent by the API Client to obtain the list of inactive but ready-to-deploy scripts under a given account.

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.
ScriptFilter FilterBase 0..1 No  
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.
ScriptId [element ScriptFilter] string 0..1 No If present, this element restricts the output of GetScripts() to a single script.

Example

This example does not include the optional script filter.

<prov:GetScriptsRequest
    xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
    <prov:Credentials>
        <prov:UserName>ericsmith</prov:UserName>
        <prov:Password>ericsmith</prov:Password>
    </prov:Credentials>
</prov:GetScriptsRequest>

The following examples do include a script filter. Filtering by create date:

<prov:GetScriptsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>ericsmith</prov:UserName>
      <prov:Password>ericsmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:ScriptFilter>
      <prov:QueryByCreateDate dateQueryType="GreaterThan"
                              queryDate="2012-06-11T20:12:26.54"/>
      <prov:QueryByCreateDate dateQueryType="LessThan"
                              queryDate="2012-08-11T20:12:26.54"/>
   </prov:ScriptFilter>
</prov:GetScriptsRequest>

Filter by modify date:

<prov:GetScriptsRequest
   xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <prov:Credentials>
      <prov:UserName>ericsmith</prov:UserName>
      <prov:Password>ericsmith1</prov:Password>
   </prov:Credentials>
   <!--Optional:-->
   <prov:ScriptFilter>
      <prov:QueryByModifyDate dateQueryType="GreaterThan"
                              queryDate="2012-06-11T20:12:26.54"/>
      <prov:QueryByModifyDate dateQueryType="LessThan"
                              queryDate="2012-08-11T20:12:26.54"/>
   </prov:ScriptFilter>
</prov:GetScriptsRequest>

Filtering by AgentType:

<prov:GetScriptsRequest
   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:ScriptFilter>
      <prov:AgentType>IE</prov:AgentType>
   </prov:ScriptFilter>
</prov:GetScriptsRequest>