Project

Overview

Projects are the main organizational unit in TestRail. It is generally recommended to create a TestRail project for every real software project you want to manage within TestRail. All other data such as test suites, runs, test results, milestones etc. are directly associated with a specific project.

Fields

Name	Type	Description	Request Methods
id	Int	The unique ID of the project	getProject, getProjects, deleteProject
completedOn	Timestamp	The date/time when the project was marked as completed (as UNIX timestamp)	getProject, getProjects
url	String	The address/URL of the project in the user interface	getProject, getProjects
name	String	The name of the project	getProject, getProjects, addProject, updateProject
announcement	String	The description/announcement of the project	getProject, getProjects, addProject, updateProject
showAnnouncement	Boolean	True to show the announcement/description and false otherwise	getProject, getProjects, addProject, updateProject
suiteMode	Int	The suite mode of the project (1 for single suite mode, 2 for single suite + baselines, 3 for multiple suites) (added with TestRail 4.0)	getProject, getProjects, addProject, updateProject
isCompleted	Boolean	True if the project is marked as completed and false otherwise	getProject, getProjects, updateProject

Methods

GET Requests:

---

1. getProject

Description:

Returns an existing project.

Parameters:

Name	Type	Description	Required
projectId	Int	The ID of the project	Yes

Returns:

• Project

Example:

val someProject = Project().getProject(projectId = 1)

 

2. getProjects

Description:

Returns the list of available projects.

Parameters:

Name	Type	Description	Required
isCompleted	Boolean	True to return completed projects only. False to return active projects only.	No

Returns:

• List<Project>

Example:

val someProjectsList = Project().getProjects()

 

POST Requests:

---

1. addProject

Description:

Creates a new project (admin status required).

Required Parameters:

• name

Returns:

• Project

Example:

val someProject = Project(name = "Some Project Name")
someProject.addProject()

 

2. updateProject

Description:

Updates an existing project (admin status required; partial updates are supported, i.e. you can submit and update specific fields only).

Required Parameters:

• projectId

Returns:

• Project

Example:

val someProject = Project(
    name = "Some Updated Project Name",
    id = 1
)
someProject.updateProject()

 

3. deleteProject

Description:

Deletes an existing project (admin status required).

Required Parameters:

• projectId

Example:

val someProject = Project(id = 1)
someProject.deleteProject()