Get projects by Query

Description

Returns a list of projects by query (filter).

You can also add an additional parameter ("include=user-role") to the request to return user role data. This parameter is available in LoadRunner Enterprise 2023 and later. The user role response is supported as JSON only; XML is not currently supported.

URL

Copy code
Get project by query
/Admin/rest/v1/projects?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}
Copy code
Get project by query and include user roles
/Admin/rest/v1/projects?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}&include=user-roles

Project Query Values

QUERY_NAME options:

  • VusersLimit
  • ConcurrentRunsLimit
  • ID 
  • MachineLimit
  • VUDSLimit
  • Name
  • Domain

AdditionalData options:

  • UsersRoles
    • UserName
    • UserID
    • Role

Remarks

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

HTTP Method

GET: Returns a list of projects (and optionally, project users) according to the 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

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 Project response.

See Also

Get all Projects
Get or update project by project ID
Remove Projects
Create a project
Test database connection to a project (for Oracle environments only)
Update database connection to a project (for Oracle environments only)