Share this page

# Get all projects

## Description

Gets all projects.

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

## URL

Copy code
Get all projects

    /Admin/rest/v1/projects

Copy code
Get all projects and include user roles

    /Admin/rest/v1/projects?include=user-roles

## Remarks

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

## HTTP method

GET: Returns the project response.

## Request

Headers:

One of the following:

- Content-Type: application/xml

- Content-Type: application/json

Cookies:

Version | Cookie
--- | ---
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 examples:

Copy code
XML example: Get all projects

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

Copy code
XML example: Get all projects and include user role data

    GET http://<LRE_Server>/Admin/rest/v1/projects?include=user-roles
    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.

Element | Description
--- | ---
VusersLimit | The maximum number of Vusers available to the project.
PoolID | ID of the project's host pool.
ConcurrentRunsLimit | The maximum number of concurrent test runs allowed within a project.
ID | The project's ID.
MachineLimit | The total number of hosts (Controller + load generators) reserved for a timeslot may not exceed this limit.
VUDSLimit | The maximum number of Vusers that a project can run at once within a 24 hour period (the Virtual User Flex Day). The total number used by all of the project's concurrent performance tests must not exceed this limit.
Name | The name of the project.
Domain | The domain in which the project was created.
ProjectState | The state of the project (Active, Inactive, InactiveLab, Deleted).
AdditionalData (Optional - if `?include=user-roles` added to the request) | UsersRoles UserName. The user's name. UserID. The user's ID. Role. The name of the role assigned to the user. For the list of roles available in the project, see the Users page in OpenText Enterprise Performance Engineering Admin.

Response examples:

Copy code
XML example: Project response

    <Projects>
        <Project>
            <VusersLimit>10</VusersLimit>
            <PoolID>1000</PoolID>
            <ConcurrentRunsLimit>1</ConcurrentRunsLimit>
            <MachineLimit>1000</MachineLimit>
            <VUDSLimit>0</VUDSLimit>
            <ID>1001</ID>
            <Name>INST_PATCH</Name>
            <Domain>DEFAULT</Domain>
            <ProjectState>Active</ProjectState>
        </Project>
    </Projects>

Copy code
JSON example: Project response

    [
        {
            "ID": 2,
            "ProjectID": 2,
            "Name": "Auto_fe4fkrhlqym_0",
            "Domain": "AUTO",
            "ProjectState": "Active",
            "RecurrentReservation": "0",
            "VusersLimit": 50,
            "PoolID": 1000,
            "ConcurrentRunsLimit": 1,
            "MachineLimit": 10,
            "VUDSLimit": 0
        },
        {
            "ID": 3,
            "ProjectID": 3,
            "Name": "Auto_rtyqrboues5_1",
            "Domain": "AUTO",
            "ProjectState": "Active",
            "RecurrentReservation": "0",
            "VusersLimit": 50,
            "PoolID": 1000,
            "ConcurrentRunsLimit": 1,
            "MachineLimit": 10,
            "VUDSLimit": 0
        }
    ]

Copy code
XML example: Project response including user role data example

    <Projects>
        <Project>
           <ConcurrentRunsLimit>2</ConcurrentRunsLimit>
           <Domain>DEFAULT</Domain>
           <AdditionalData>
              <UserRoles>
                 <element>
                    <Role>Viewer</Role>
                    <UserID>251</UserID>
                    <UserName>sa</UserName>
                 </element>
                 <element>
                    <Role>Viewer</Role>
                    <UserID>254</UserID>
                    <UserName>Alan</UserName>
                 </element>
                 <element>
                    <Role>Viewer</Role>
                    <UserID>255</UserID>
                    <UserName>qatest</UserName>
                 </element>
                 <element>
                    <Role>Viewer</Role>
                    <UserID>257</UserID>
                    <UserName>Julie</UserName>
                 </element>
              </UserRoles>
           </AdditionalData>
           <ID>2</ID>
           <MachineLimit>1000</MachineLimit>
           <Name>AUTOMATION_PROJECT</Name>
           <PoolID>1000</PoolID>
           <ProjectID>2</ProjectID>
           <ProjectState>Active</ProjectState>
           <RecurrentReservation null="true" />
           <VUDSLimit>0</VUDSLimit>
           <VusersLimit>1052</VusersLimit>
        </Project>
    </Projects>

Copy code
JSON example: Project response including user role data example

    [
       {
            "ID": 27,
            "ProjectID": 27,
            "Name": "project_chaos_LqLtL",
            "Domain": "DEFAULT",
            "ProjectState": "Active",
            "RecurrentReservation": "0",
            "VusersLimit": 0,
            "PoolID": 1000,
            "ConcurrentRunsLimit": 1,
            "MachineLimit": 10,
            "VUDSLimit": 0,
            "AdditionalData": {
                "UserRoles": [
                    {
                        "UserName": "sa",
                        "UserID": "3",
                        "Role": "Performance Tester"
                    }
                ]
            }
        },
        {
            "ID": 28,
            "ProjectID": 28,
            "Name": "project_chaos_DJGKm",
            "Domain": "DEFAULT",
            "ProjectState": "Active",
            "RecurrentReservation": "0",
            "VusersLimit": 0,
            "PoolID": 1000,
            "ConcurrentRunsLimit": 1,
            "MachineLimit": 10,
            "VUDSLimit": 0,
            "AdditionalData": {
                "UserRoles": [
                    {
                        "UserName": "sa",
                        "UserID": "3",
                        "Role": "Performance Tester"
                    }
                ]
            }
            }
    ]

See also:

- Get or update project by project ID
- Get projects by query
- Create a project
- Test database connection to a project (Oracle environments only)
- Update database connection to a project (Oracle environments only)

Tips to improve your search results... OpenText™ Enterprise Performance Engineering Admin API Reference OpenText™ Enterprise Performance Engineering All View Local Help Center View Online Help Center(Undefined variable: _rscC_Basic_Variables.VersionLabel)