UpdateTestParameters

This method performs partial updates on existing tests. It can be used to change one-to-many monitor properties and/or one-to-many test steps and/or one-to-many monitor site relations.

Action

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

Style

Document

Input (literal)

This is the request message for the UpdateTestParameters method. It contains one to many test update requests.

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.
PartialUpdate anyType (restriction) 1..* No One or more PartialUpdate elements appear in an UpdateTestParametersRequest. Each PartialUpdate targets a specific monitor. A PartialUpdate may be used to update the list of sites to which a monitor is deployed, the name of a test step, or one or more test parameters such as SummaryFlag, IncludeRenderTime, IP version, etc.

Output (literal)

This is the response message for the UpdateTestParameters method. It contains the status of the operation (successful or unsuccessful) and an error message when the operation was unsuccessful.

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.

Examples

Remove the expiration date

This web method allows users to remove the expiration date of a test.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
    <soapenv:Header />
    <soapenv:Body>
        <prov:UpdateTestParametersRequest>
            <prov:Credentials>
                <prov:UserName>gomez4tpeu</prov:UserName>
                <prov:Password>gomez4tpeu</prov:Password>
            </prov:Credentials>
            <prov:PartialUpdate monitorId="545017">
                <prov:MonitorProperties>
                    <prov:MonitorProperty name="ExpirationDate" value="NODATE" />
                </prov:MonitorProperties>
            </prov:PartialUpdate>
        </prov:UpdateTestParametersRequest>
    </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>
        <UpdateTestParametersResponse
               xmlns="http://www.gomeznetworks.com/schemas/provisioning">
            <ResponseStatus>SUCCESS</ResponseStatus>
        </UpdateTestParametersResponse>
    </soap:Body>
</soap:Envelope>

Move a test out of a folder

This web method allows users to move a test out of a folder.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
    <soapenv:Header />
    <soapenv:Body>
        <prov:UpdateTestParametersRequest>
            <prov:Credentials>
                <prov:UserName>gomez4tpeu</prov:UserName>
                <prov:Password>gomez4tpeu</prov:Password>
            </prov:Credentials>
            <prov:PartialUpdate monitorId="545017">
                <prov:MonitorProperties>
                    <prov:MonitorProperty name="Folder" value="" />
                </prov:MonitorProperties>
            </prov:PartialUpdate>
        </prov:UpdateTestParametersRequest>
    </soapenv:Body>
</soapenv:Envelope>

Response

<?xml version="1.0"?>
<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>
        <UpdateTestParametersResponse
               xmlns="http://www.gomeznetworks.com/schemas/provisioning">
            <ResponseStatus>SUCCESS</ResponseStatus>
        </UpdateTestParametersResponse>
    </soap:Body>
</soap:Envelope>