Share this page

# Return, delete, or update a test by test ID

## Description

Returns, deletes, or updates a test design by the specified test ID.

## URL

Copy code

    /LoadTest/rest/domains/{domainName}/projects/{projectName}/tests/{ID}

## Remarks

When updating the test data, the request body contains only the data to be changed. The request body is a subset of Test entity XML.

The test data can be passed as XML containing the equivalent data.

## HTTP Method

GET: Returns the design test.

PUT: Updates the design test.

DELETE: Deletes the test.

## Request

Headers:

Content-Type: application/xml

Cookies:

Version 2020 (or later) | LWSSO_COOKIE_KEY={LwssoCookie};
Versions earlier than 2020 | LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request Body:

GET: No request body.

DELETE: No request body.

PUT: An XML describing the data to be updated in the test. In addition to the updated element, the following elements must always appear: `<WorkloadType>`, `<LGDistribution>`, `<Groups>` and `<Scheduler>`. See Test entity XML.

Note: Runtime settings data provided in the request overrides the data in the system. For group RTS, only a few values (Pacing, Log, and ThinkTime) are displayed via the REST request. All remaining runtime settings are reset to the script's default settings. For details, see Runtime Settings XML.

Request Example - GET
Copy code

    GET http://<LRE_Server>/LoadTest/rest/domains/TEST_DOMAIN/projects/TEST_PROJECT/tests/1
    Content-Type: application/xml
    Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

Request Example - PUT request which updates the test
Copy code

    PUT http://<LRE_Server>/LoadTest/rest/domains/TEST_DOMAIN/projects/TEST_PROJECT/tests/1
    Content-Type: application/xml
    Body:

    <Content xmlns="http://www.hp.com/PC/REST/API">
    <WorkloadType>
       <Type>Basic</Type>
       <SubType>by test</SubType>
       <VusersDistributionMode>by number</VusersDistributionMode>
    </WorkloadType>
    <LGDistribution>
       <Type>all to each group</Type>
       <Amount>1</Amount>
    </LGDistribution>
    <Groups>
       <Group>
           <Name>auto_group</Name>
           <Vusers>23</Vusers>
           <Script>
               <ID>4</ID>
           </Script>
       </Group>
    </Groups>
    <Scheduler>
    <Actions>
       <Action>
          <Initialize Type="just before vuser runs">
          <Vusers>0.0</Vusers>
          </Initialize Type>
       </Action>
       <Action>
           <StartVusers Type="gradually">
           <Ramp>
               <TimeInterval>
                   <Days>0</Days>
                   <Hours>0</Hours>
                   <Minutes>0</Minutes>
                   <Seconds>50</Seconds>
               </TimeInterval>
            </Ramp>
            <StartVusers Type>
       </Action>
       <Action>
           <Duration Type="run for">
           <TimeInterval>
               <Days>0</Days>
               <Hours>0</Hours
               <Minutes>2</Minutes>
               <Seconds>0</Seconds>
           </TimeInterval>
           </Duration>
       </Action>
       <Action>
           <StopVusers Type="simultaneously">
           </StopVusers>
       </Action>
    </Actions>
    </Scheduler>
    </Content>

## Response

Headers:

One of:

- Content-Type: application/xml
- Content-Type: application/json

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

HTML Body:

GET: Returns the data on the entity in the test entity XML or equivalent JSON string. See Test creation XML.

DELETE and PUT: No body returned.

## See Also

Create a test
Test entity XML
Test creation XML

Tips to improve your search results... LoadRunner Enterprise REST API Reference LRE REST API All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic(Undefined variable: _rscC_Basic_Variables.VersionLabel)