projects/{projectID}

Description

Returns or updates a project (per the specified project ID).

URL

/Admin/rest/v1/projects/{projectID}

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)

LWSSO_COOKIE_KEY={LwssoCookie};

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. 

GET http://<LRE_Server>/Admin/rest/v1/projects/1001}
Content-Type: application/xml
Accept: application/xml
Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

PATCH http://<LRE_Server>/Admin/rest/v1/projects/1001
Content-Type: application/xml
Accept: application/xml
Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

<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

projects (Get Projects)
projects (Get by Query)
projects (Remove Projects)
projects (Create a project)