Create a project

Available in versions: 2020 SP3 and later

Description

Creates a new project.

URL

Copy code
/Admin/rest/v1/projects

Remarks

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

HTTP method

POST: Creates a new project.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

An XML or JSON describing the project and other optional details.

The request contains the following fields.

ElementDescription
ConcurrentRuns The maximum number of concurrent test runs allowed within a project.
Description(Optional) A description of the project.

DestinationProject

Available in versions: 2021 R2 and later

For Oracle environments only: Allows you to use a custom Oracle user created beforehand, which contains the following properties:

  • "CustomSchemaName" - Name of the Oracle user to be used to create the project.

  • "CustomPassword" - Password of the Oracle user to be used to create the project.

Domain The domain in which the project was created.
HostPoolIDID for the host pool.
HostsLimitThe maximum number of hosts available to the project.
Name The name given to the project when it was created.
RecurrentReservation

(Optional) Indicate if a recurrent timeslot is enabled. Use one of the following:

  • "0" to indicate recurrent timeslot is disabled.

  • "1" to indicate recurrent timeslot is enabled.

PostRunAction

(Optional) Use one of the following strings:

  • "NoEnforcement"

  • "DoNotCollate"

  • "CollateResults"

  • "CollateAndAnalyseResults"

VUDSLimit

The maximum number of VUFDs a project can run at once. The total number used by all of the project's concurrent performance tests must not exceed this limit.

VugenWorkingMode

(Optional) Use one of the following strings:

  • "Runtime Files"

  • "User Defined"

VusersLimitThe maximum number of Vusers available to the project.

Request examples:

Copy code
XML example:
<Project> 
    <ConcurrentRuns>1</ConcurrentRuns>
    <Description>Created via public API, users assigned</Description>
    <Domain>DEFAULT</Domain>
    <HostPoolID>1000</HostPoolID>
    <HostsLimit>30</HostsLimit>
    <Name>API_PROJ_1</Name>
    <RecurrentReservation>0</RecurrentReservation>
    <PostRunAction>DoNotCollate</PostRunAction>
    <VUDSLimit>0</VUDSLimit>
    <VugenWorkingMode>Runtime Files</VugenWorkingMode>
    <VusersLimit>35</VusersLimit>
    <DestinationProject>
        <CustomSchemaName>DEFAULT_API_PROJ_1_CUSTOM_DB</CustomSchemaName>
        <CustomPassword>API_PROJ_1_CUSTOM_PASSWORD</CustomPassword>
    </DestinationProject>
</Project> 
Copy code
JSON example:
{
        "ConcurrentRuns": "1",
        "Description": "Created via public API, users assigned",
        "Domain": "DEFAULT",
        "HostPoolID": "1000",
        "HostsLimit": "30",
        "Name": "API_PROJ_1_1",
        "RecurrentReservation": "0",
        "PostRunAction": "DoNotCollate",
        "VUDSLimit": "0",
        "VugenWorkingMode": "Runtime Files",
        "VusersLimit": "35",
        "DestinationProject": {
            "CustomSchemaName": "LRE_ULT_PROJECT_CHAOS_FY_DB",
            "CustomPassword": "W3lcome1"
        }
}

Response

Headers:

One of:

  • Accept: application/xml

  • Accept: application/json

Cookies:

None

HTML Return Code:

One of the HTTP return codes.

Upon successful creation of project, returns HTTP status 201 (Created).

HTML body:

Returns data on the new entity.

Response examples:

Copy code
XML example:
<Project>
    <ID>202</ID>
    <Name>API_PROJ_1</Name>
    <Domain>DEFAULT</Domain>
    <ProjectState>Active</ProjectState>
    <VusersLimit>35</VusersLimit>
    <PoolID>1000</PoolID>
    <ConcurrentRunsLimit>1</ConcurrentRunsLimit>
    <MachineLimit>30</MachineLimit>
    <VUDSLimit>0</VUDSLimit>
</Project>
Copy code
JSON example:
{
  "ID": 3,
  "Name": "API_PROJ_1",
  "Domain": "DEFAULT",
  "ProjectState": "Unknown",
  "RecurrentReservation": "0",
  "VusersLimit": 35,
  "PoolID": 1000,
  "ConcurrentRunsLimit": 1,
  "MachineLimit": 30,
  "VUDSLimit": 0
}

See also: