ProvisionTests

This web method is used to provision one or more Single Step or Multi Step browser tests. Each test defined in the request constitutes a monitor order. The response indicates the success or failure of each monitor order in the request. Each monitor order will be handled in its own transaction, and the service will process the monitor orders in sequence until all the monitor orders have been processed or one monitor order fails.

Action

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

Style

Document

Input (literal)

This message contains a single ProvisionTestsRequest element. The ProvisionTestsRequest element defines one or more SingleStep or MultiStep browser tests. Each test definition constitutes a monitor order.

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.
SingleStepMonitors anyType (restriction) 0..1 No A SingleStepMonitors element appears in a ProvisionTestsRequest and is used to create one or more Backbone tests that browse a single URL.
MultiStepMonitors anyType (restriction) 0..1 No Appears in a ProvisionTestsRequest. A MultiStepMonitors is a collection of one or more MultiStepMonitor elements. See MultiStepMonitor.

Output (literal)

This message contains a single ProvisionTestsResponse element defining one or more monitor order responses. The success or failure of each monitor order is shown. If a failure is encountered, the reason for the failure is shown under the monitor order that failed. However many monitor orders the request contained, there are never more than one failed monitor order in the response, because processing is halted the moment the failure occurs.

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.
MonitorOrderResponses anyType (restriction) 1..1 No MonitorOrderResponses are collections of MonitorOrderResponse elements. They occur in the responses of both ProvisionTests and UpdateTests operation invocations. See the MonitorOrderResponse help page for more information.

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:ProvisionTestsRequest>
         <prov:Credentials>
            <prov:UserName>EricS</prov:UserName>
            <prov:Password>EricS</prov:Password>
         </prov:Credentials>
         <prov:SingleStepMonitors>
            <prov:SingleStepMonitor name="Provision Single Step Monitor 002"
               folder="Dynatrace Testing" agentType="FF"
               summaryFlag="Off" includeRenderTimeFlag="Off"
               frequencyInMins="60" expirationDate="2012-08-01T10:10:10"
               ipVersion="IPv4_only" monitorStatus="Active" folderStatus="Active">
               <prov:MonitorSites>
                  <prov:MonitorSite siteId="884" />
               </prov:MonitorSites>
               <prov:URL>http://www.dynatrace.com</prov:URL>
            </prov:SingleStepMonitor>
         </prov:SingleStepMonitors>
         <prov:MultiStepMonitors>
            <prov:MultiStepMonitor name="Provision Multi Step Monitor 002"
               folder="Dynatrace Testing" agentType="IE" summaryFlag="Off"
               includeRenderTimeFlag="Off" frequencyInMins="60"
               expirationDate="2012-08-01T10:10:10" ipVersion="IPv4_only"
               monitorStatus="Active" folderStatus="Active" scriptId="258244">
               <prov:MonitorSites>
                  <prov:MonitorSite siteId="886"/>
               </prov:MonitorSites>
            </prov:MultiStepMonitor>
         </prov:MultiStepMonitors>
      </prov:ProvisionTestsRequest>
   </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>
      <ProvisionTestsResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <MonitorOrderResponses>
            <MonitorOrderResponse name="Provision Single Step Monitor 002"
               folder="Dynatrace Testing" monitorId="270619" monitorStatus="Active"
               orderStatus="SUCCESS">
               <Message>Successfully provisioned monitor: AccountName
                = DEV - Eric Smith, MonitorName = Provision
                Single Step Monitor 002, MonitorId =270619</Message>
            </MonitorOrderResponse>
            <MonitorOrderResponse name="Provision Multi Step Monitor 002"
               folder="Dynatrace Testing" monitorId="258244" monitorStatus="Active"
               orderStatus="SUCCESS">
               <Message>Successfully provisioned monitor:
               AccountName = DEV - Eric Smith, MonitorName =
               Provision Multi Step Monitor 002, MonitorId =258244</Message>
            </MonitorOrderResponse>
         </MonitorOrderResponses>
      </ProvisionTestsResponse>
   </soap:Body>
</soap:Envelope>