Create a project
Available in versions: 2020 SP3 and later
Description
Creates a new project.
URL
/Admin/rest/v1/projects
Remarks
None
HTTP Method
POST: Creates a new project.
Request
Headers:
Content-Type: application/xml
Accept: application/json, application/xml
Cookies:
ADM_LWSSO={AdmLwssoCookie};
Request Body:
An XML describing the project and other optional details.
The fields in the request are:
Element | Description |
---|---|
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:
|
Domain | The domain in which the project was created. |
HostPoolID | ID for the host pool. |
HostLimit | The 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:
|
PostRunAction | (Optional) Use one of the following strings:
|
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:
|
VusersLimit | The maximum number of Vusers available to the project. |
<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>
Response
Headers:
None
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.
{
"ID": 3,
"Name": "API_PROJ_1",
"Domain": "DEFAULT",
"ProjectState": "Unknown",
"RecurrentReservation": "0",
"VusersLimit": 35,
"PoolID": 1000,
"ConcurrentRunsLimit": 1,
"MachineLimit": 30,
"VUDSLimit": 0
}
See Also
Get all Projects
Get or update project by project ID
Get projects by Query
Remove Projects
Test database connection to a project (for Oracle environments only)
Update database connection to a project (for Oracle environments only)