Share this page

# Add, update, or remove a group from a test

## Description

A group in a test.

## URL

Copy code

    /LoadTest/rest/domains/{domainName}/projects/{projectName}/tests/{ID}/Groups/{group name}

## Remarks

Adds a group to a test, deletes a group from a test, gets data on group, or updates the data of an existing group in the test.

PUT: If the group exists in the test, the group data is updated. If not, a new group is added. The data can be passed as XML containing the equivalent data.

## HTTP Method

GET: Gets the data on the group.

PUT: Adds or updates the group.

DELETE: Removes the group from the test.

## Request

Headers:

PUT:

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. See Test entity XML

Request Example
Copy code

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

    <Group xmlns="http://www.hp.com/PC/REST/API">
        <Vusers>30.0</Vusers>
        <Name>group1</Name>
        <Script>
            <ID>2</ID>
        </Script>
        <RTS>…See the RTS entity XML...</RTS>
    <!-- Include this section only if the schedule is by group. See tests and test entity XML. -->
        <Scheduler>…</Scheduler>
    </Group>

## Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

HTML Body:

PUT, DELETE: None

GET: The data on the group.

Example
Copy code

    <Group xmlns="http://www.hp.com/PC/REST/API">
        <Name>login_logout</Name>
        <Vusers>10</Vusers>
        <Script>
            <ID>1</ID>
        </Script>
        <RTS>
            <Pacing>
                <NumberOfIterations>1</NumberOfIterations>
                <StartNewIteration Type="immediately"/>
            </Pacing>
            <ThinkTime Type="replay"/>
            <Log Type="standard">
                <LogOptions Type="on error">
                    <CacheSize>1</CacheSize>
                </LogOptions>
            </Log>
        </RTS>
    </Group>

## See Also

Create a test
Get or delete all groups in test
Runtime Settings 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)