Get or update project by project ID

Description

Returns or updates a project by the specified project ID.

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/update project by ID
/Admin/rest/v1/projects/{projectID}
Copy code
Get/update project by ID and include user roles
/Admin/rest/v1/projects/{projectID}?include=user-roles

Remarks

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

HTTP Method

GET: Returns the project information.

PATCH: Updates the project.

Request

Headers:

Content-Type: application/xml

Accept: application/xml

Cookies:

Version 2020 (or later)

ADM_LWSSO={AdmLwssoCookie};

Versions earlier than 2020

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

Request Body:

GET: No request body.

PATCH: An XML describing the data to be updated in the project.

Copy code
Get project by ID
GET http://<LRE_Server>/Admin/rest/v1/projects/1001
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
Get project by ID and include its user role data
GET http://<LRE_Server>/Admin/rest/v1/projects/1001?include=user-roles
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
PATCH http://<LRE_Server>/Admin/rest/v1/projects/1001
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<Project> 
  <PoolID>1003</PoolID>  
</Project> 

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

Upon successful deletion, returns HTTP status 200 (OK).

HTML Body:

GET: Returns the data on the entity in the response. See Project response.

PATCH: No body returned.

See Also

Get all Projects
Get projects by Query
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)