Get all runs

Description

Gets all runs.

URL

Copy code
/Admin/rest/v1/runs

Remarks

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

GET: Returns the run response.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

VersionCookie
2023, 24.1, and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request body:

None

Request example:

Copy code
GET http://<LRE_Server>/Admin/rest/v1/runs
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML return code:

One of the HTTP return codes.

HTML body:

The response contains the following fields.

ElementDescription
IDThe Run ID.
RunIDThe project run ID.
TestIDThe test ID.
ProjectThe name of the project.
DomainThe domain name.
TestNameThe name given to the test when it was created.

RunName

(previously Name)

The run name.
StartDate

The date and time the run started (YYYY:MM:DD HH:MM:SS).

EndDate

The date and time the run ended (YYYY:MM:DD HH:MM:SS).

DurationThe run time, in minutes.
UserName

The name of the user running the test.

ControllerNameThe Controller involved in the test run.
LoadGeneratorsThe load generators involved in the test run (separated by a semi-colon).

State

(previously RunState)

One of:

  • Before Collating Results
  • Before Creating Analysis Data
  • Canceled
  • Collating Results
  • Creating Analysis Data
  • Failed Collating Results
  • Failed Creating Analysis Data
  • Finished
  • Initializing
  • Pending Creating Analysis Data
  • Run Failure
  • Running
  • Stopping

VusersMax

(previously PCVUsersMax)

The maximum number of concurrent Vusers that ran in the test.

VusersAvg

(previously PCVUsersAvg)

The average number of Vusers used per run.

VusersInvolved

(previously InvolvedVusers)

The total number of Vusers that ran in the test.
TimeslotID The ID of the time slot.

Response examples:

Copy code
XML example:
<LabRuns>
  <LabRun> 
    <ID>1042</ID>
    <RunID>12</RunID>
    <Project>INST_PATCH</Project>  
    <Domain>DEFAULT</Domain>
    <TestID>4</TestID>
    <TestName>LT_0_nlhvC</TestName>
    <RunName>AdhocRun_2017-02-26 14:40:32</RunName>
    <StartDate>2017:02:26 17:41:15</StartDate>
    <EndDate>2017:02:26 17:42:18</EndDate>
    <Duration>1</Duration>
    <UserName>sa</UserName>
    <ControllerName>MyController.net</ControllerName>
    <LoadGenerators>LG1.net;LG2.net</LoadGenerators>
    <State>Finished</State>
    <VusersMax>20</VusersMax>
    <VusersAvg>8</VusersAvg> 
    <VusersInvolved >10</VusersInvolved >
    <TimeslotID>1083</TimeslotID>
  </LabRun> 
  <LabRun> 
    <ID>1037</ID>
    <RunID>7</RunID>
    <Project>INST_PATCH</Project>
    <Domain>DEFAULT</Domain>
    <TestID>4</TestID>
    <TestName>LT_0_nlhvC</TestName>
    <RunName>AdhocRun_2017-02-26 14:40:32</RunName>
    <StartDate>2017:02:26 14:41:32</StartDate>
    <EndDate>2017:02:26 14:45:05</EndDate>
    <Duration>4</Duration>
    <UserName>sa</UserName>
    <ControllerName>MyController.net</ControllerName>
    <LoadGenerators>LG1.net;LG2.net</LoadGenerators>
    <State>Finished</State>
    <VusersMax>20</VusersMax>
    <VusersAvg>6</VusersAvg>
    <VusersInvolved>10</VusersInvolved>
    <TimeslotID>1075</TimeslotID>
  </LabRun> 
</LabRuns> 
Copy code
JSON example:
[
    {
        "ID": 1000,
        "RunID": 11,
        "TestID": 176,
        "Project": "AUTOMATION_PROJECT_2024_3",
        "Domain": "DEFAULT",
        "TestName": "e2e_test",
        "RunName": "AdhocRun_2024-04-22 21:38:37",
        "StartDate": "2024-04-22T21:39:18.270927",
        "EndDate": "2024-04-22T21:40:49.865477",
        "Duration": 1,
        "UserName": "auto_user_gug3a5kbvqa",
        "ControllerName": "lreh1-nightly-mssql-clean.lr.admlabs.aws.swinfra.net",
        "LoadGenerators": "lreh2-nightly-mssql-clean.lr.admlabs.aws.swinfra.net(2);",
        "State": "Finished",
        "VusersMax": 2,
        "VUsersAvg": 2,
        "VusersInvolved": 2,
        "TimeslotID": 1087
    },
    {
        "ID": 1001,
        "RunID": 12,
        "TestID": 178,
        "Project": "AUTOMATION_PROJECT_2024_3",
        "Domain": "DEFAULT",
        "TestName": "LT_nyPEx",
        "RunName": "AdhocRun_2024-04-22 23:02:16",
        "StartDate": "2024-04-22T23:02:27.908477",
        "EndDate": "2024-04-22T23:02:54.260434",
        "Duration": 0,
        "UserName": "sa",
        "ControllerName": "lreh1-nightly-mssql-clean.lr.admlabs.aws.swinfra.net",
        "LoadGenerators": "lreh2-nightly-mssql-clean.lr.admlabs.aws.swinfra.net(1);",
        "State": "Finished",
        "VusersMax": 0,
        "VUsersAvg": 0,
        "VusersInvolved": 1,
        "TimeslotID": 1089
    }
]

See also: