Create Project From Template
This endpoint allows the creation of a new Selenium project using a predefined template. Users must have the PROJECT_CREATE
authority to use this endpoint.
Endpoint Information
URL:
https://testinium.io/Testinium.RestApi/api/projects/template
Method:
POST
Authentication: Required (
Bearer Token
)
Request Body
The request body must be in JSON format and include the following fields:
project_dto
ProjectDTO
Yes
The details of the project being created, including name, description, etc.
site_url
String
No
The site URL for the project, defaults to https://www.testinium.com
if invalid.
ProjectDTO
Fields:
ProjectDTO
Fields:project_name
String
Yes
The name of the project.
description
String
No
A brief description of the project.
enabled
Boolean
Yes
Specifies whether the project is enabled.
company_id
Long
Yes
The ID of the company to which the project belongs.
types
List<String>
Yes
A list of test types associated with the project (e.g., IOS
, ANDROID
).
repository_path
String
Yes
The path to the project's repository.
test_framework
String
Yes
The testing framework used by the project (e.g., SELENIUM
).
test_file_type
String
Yes
The type of test files used (e.g., SELENIUM_JAVA
).
test_runner_tool
String
Yes
The tool used to run the tests (e.g., MAVEN
).
branch_name
String
No
The Git branch associated with the project.
vcs_type
String
No
The version control system type (e.g., SVN
, GIT
).
testrail_enabled
Boolean
No
Indicates whether the project integrates with TestRail.
jira_enabled
Boolean
No
Indicates whether the project integrates with Jira.
xray_enabled
Boolean
No
Indicates whether the project integrates with Xray.
Example JSON:
{
"project_name": "project_name",
"repository_path": "repository_path",
"test_file_type": "SELENIUM_JAVA",
"test_framework": "SELENIUM",
"test_runner_tool": "MAVEN",
"company_id": company_id,
"site_url": "https://www.siteurl.com/"
}
Response
If the project is successfully created, the endpoint returns the created project details.
{
"id": 1427,
"project_name": "project_name",
"enabled": true,
"types": [
"WEB"
],
"repository_path": "repository_path",
"test_framework": "SELENIUM",
"test_file_type": "SELENIUM_JAVA",
"test_runner_tool": "MAVEN",
"created_at": "2024-12-06T03:29:33Z",
"updated_at": "2024-12-06T03:29:33Z",
"created_by": "mehmetaksahin",
"updated_by": "mehmetaksahin",
"branch_name": "master",
"testrail_enabled": false,
"jira_enabled": false,
"xray_enabled": false
}
Error Codes
400
INVALID_REQUEST
The request body contains invalid or missing fields.
400
MISSING_REQUIRED_FIELD
The required field project_dto
is missing.
403
ACCESS_DENIED
The user does not have the PROJECT_CREATE
authority.
500
INTERNAL_SERVER_ERROR
An unexpected error occurred during project creation.
Example Request
curl --location --request POST "https://testinium.io/Testinium.RestApi/api/projects/template" \
--header 'Authorization: Bearer <your_access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"project_name": "project_name",
"repository_path": "repository_path",
"test_file_type": "SELENIUM_JAVA",
"test_framework": "SELENIUM",
"test_runner_tool": "MAVEN",
"company_id": company_id,
"site_url": "https://www.siteurl.com/"
}'
Last updated