Get Run by Query
Description
Returns a list of runs by query (filter).
URL
/Admin/rest/v1/runs?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}
Runs Query Values
QUERY_NAME options:
ID
RunID
TestID
Domain;Project
(filtering byDomain
orProject
requires bothDomain
andProject
)TestName
Name
StartDate
EndDate
Duration
UserName
ControllerName
RunState
PCVUsersMax
PCVUsersAvg
InvolvedVusers
TimeslotID
Remarks
The runs data can be passed as XML containing the equivalent data.
HTTP Method
GET: Returns a list of runs by query.
Request
Headers:
Content-Type: application/xml
Accept: application/xml
Cookies:
Versions 2023 and later | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; |
Versions 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}; |
Versions 2021 - 2021 R2 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE}; |
Versions 2020 - 2020 SP3 | ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; |
Versions earlier than 2020 | LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE}; QCSession={QC_SESSION_COOKIE_VALUE}; |
Request Body:
None
GET http://<LRE_Server>/Admin/rest/v1/runs?query={TestID[1]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
GET http://<LRE_Server>/Admin/rest/v1/runs?query={ID[>1030];ID[<1035];RunID[32]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
GET http://<LRE_Server>/Admin/rest/v1/runs?fields=ID&order-by={ID[DESC]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Example of the resulting response:
<LabRuns>
<LabRun>
<ID>1042</ID>
</LabRun>
<LabRun>
<ID>1041</ID>
</LabRun>
<LabRun>
<ID>1040</ID>
</LabRun>
</LabRuns>
GET http://<LRE_Server>/Admin/rest/v1/runs?fields=ID,Project&order-by={ID[ASC]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Example of the resulting response:
<LabRuns>
<LabRun>
<ID>1013</ID>
<Project>INST_PATCH</Project>
</LabRun>
<LabRun>
<ID>1014</ID>
<Project>INST_PATCH</Project>
</LabRun>
</LabRuns>
GET http://<LRE_Server>/Admin/rest/v1/runs?query={StartDate[>'2017-02-01%2014:17:17']}&fields=ID,StartDate&order-by={ID[ASC]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Example of the resulting response:
<LabRuns>
<LabRun>
<ID>1014</ID>
<StartDate>2017-02-01 14:27:15</StartDate>
</LabRun>
<LabRun>
<ID>1017</ID>
<StartDate>2017-02-01 15:13:13</StartDate>
</LabRun>
</LabRuns>
GET http://<LRE_Server>/Admin/rest/v1/runs?query={Domain[DEFAULT];Project[INST_PATCH]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Response
Headers:
Content-Type: application/xml
Cookies:
None
HTML Return Code:
One of the HTTP Return Codes.
HTML Body:
GET: Returns the data on the entity in the response. See Run response.
See Also