Start a Test Run

Description

Runs a test.

URL

/LoadTest/rest/domains/{domainName}/projects/{projectName}/Runs

Remarks

The ID of the test to run is in the request data. See below.

HTTP Method

POST: Creates the Run resource. Creating the resource runs the test.

Request

Headers:

Content-Type: application/xml

None

Cookies:

Version 2020 (or later)

LWSSO_COOKIE_KEY={LwssoCookie};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request Body:

An XML describing the requested run. The fields in the response are:

ElementDescription
RunThe top-level element.
PostRunAction

One of:

  • Do Not Collate
  • Collate Results 

  • Collate And Analyze

TestID

The test ID.

TestInstanceID

The test instance ID from LoadRunner Enterprise in the Test Lab perspective.

TimeslotDuration
     /Hours
     / Minutes

The time to allot for the test.

The minimal time that can be entered when creating a new timeslot is 30 minutes. You can set the time duration in 15 minute increments. For example, 30 minutes, 45 minutes, 1 hr, 1hr 15 minutes.

VudsModeIf true, the test consumes Virtual User Day (VUD) licenses.
POST http://<LRE_Server>/LoadTest/rest/domains/alex-qc/projects/PCdemo/Runs
Content-Type: application/xml
Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

<Run xmlns="http://www.hp.com/PC/REST/API">
 <PostRunAction>Collate And Analyze</PostRunAction>
 <TestID>5</TestID>
 <TestInstanceID>4</TestInstanceID>
 <TimeslotDuration>
 <Hours>1</Hours>
 <Minutes>30</Minutes>
 </TimeslotDuration>
 <VudsMode>false</VudsMode>
</Run>

Response

Headers:

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

Location: { the link to the new Run entity}. This link is used in all subsequent references to the run. See below in the "See Also" section.

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

HTML Body:

The data on the new entity. See Run Status XML.

See Also

These resources consume the link returned in the Location header:
Get Run Status
Results
Results/{ID}
Runs (Get Run by Query)
stop
stopNow
abort