Create a project

Available in versions: 2020 SP3 and later

Description

Creates a new project.

URL

Copy code
/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:

LWSSO_COOKIE_KEY={LwssoCookie};

Request Body:

An XML describing the project and other optional details.

The fields in the request are:

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.
HostLimitThe 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 VUDs 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.

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.

See Also

Get Projects
Returns or update a project by 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)