GetScripts

This web method returns all the scripts under a qualified account. A ScriptFilter can be included in the request, restricting the output of the query to scripts matching the filter.

Action

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

Style

Document

Input (literal)

This message contains a single GetScriptsRequest element. The GetScriptsRequest may or may not contain a ScriptFilter restricting the output of the GetScriptsRequest.

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

Output (literal)

This message contains a single GetScriptsResponse element. This element contains all of the inactive browser scripts under a given account. Inactive scripts are available to be converted into Backbone tests that run on one or more sites in the Dynatrace Portal network. The scripts in the output can be restricted to match a ScriptFilter if one has been provided in the GetScriptsRequest.

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.
Scripts anyType (restriction) 1..1 No A Scripts element appears only in a GetScripts operation response. It represents a collection of GSL scripts in the Dynatrace Portal for the account that have yet to be incorporated into a browser test.

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:GetScriptsRequest>
         <prov:Credentials>
            <prov:UserName>erics</prov:UserName>
            <prov:Password>erics</prov:Password>
         </prov:Credentials>
         <!--Optional:-->
         <prov:ScriptFilter>
            <!--Optional:-->
            <prov:AgentType>IE</prov:AgentType>
            <!--Zero or more repetitions:-->
            <prov:QueryByCreateDate dateQueryType="LessThan"
              queryDate="2012-07-29T14:16:54"/>
         </prov:ScriptFilter>
      </prov:GetScriptsRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
      <GetScriptsResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <Scripts>
            <Script agentType="IE" scriptId="268096"
              status="Inactive" createDate=
              "2012-07-23T19:19:23.78" modifyDate=
              "2012-07-23T19:19:23.78">
               <Description>MultiStepScript 7/23/2012
              3:19:22 PM</Description>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.compuware.com/</URL>
                     <DisplayName>Compuware Corporation</DisplayName>
                  </Step>
                  <Step stepSeqNum="1">
                     <URL>http://www.compuware.com/careers/</URL>
                     <DisplayName>Compuware Corporation
                     </DisplayName>
                  </Step>
                  <Step stepSeqNum="2">
                     <URL>http://www.compuware.com/
                          careers/why-compuware.html</URL>
                     <DisplayName>Step 3</DisplayName>
                  </Step>
                  <Step stepSeqNum="3">
                     <URL>http://www.compuware.com/about/
                           mission-statement.html</URL>
                     <DisplayName>Mission Statement |
                      Compuware</DisplayName>
                  </Step>
               </Steps>
            </Script>
            <Script agentType="IE" scriptId="268097"
              status="Inactive"
              createDate="2012-07-23T19:19:31.293"
              modifyDate="2012-07-23T19:19:31.347">
               <Description>Test Script 7/23/2012 3:19:30 PM</Description>
               <Steps>
                  <Step stepSeqNum="0">
                     <URL>http://www.compuware.com</URL>
                     <DisplayName/>
                  </Step>
               </Steps>
            </Script>
         </Scripts>
      </GetScriptsResponse>
   </soap:Body>
</soap:Envelope>