Configuration

Overview

A configuration can be anything you need to test your project against, such as different operating systems or web browsers.

Fields

Name	Type	Description	Request Methods
projectId	Int	The ID of the project the configuration is associated with	getConfigs, addConfigGroup
groupId	Int	The ID of the configuration group the configuration is associated with	getConfigs, addConfig, updateConfigGroup, deleteConfigGroup
configs	List<Configuration>	List of configurations contained in a configuration group	getConfigs
id	Int	Unique ID of the configuration/configuration group	getConfigs, updateConfig, deleteConfig
name	String	Name of the configuration/configuration group	getConfigs, addConfigGroup, addConfig, updateConfigGroup, updateConfig

Methods

GET Requests:

---

1. getConfigs

Description:

Returns a list of available configurations, grouped by configuration groups (requires TestRail 3.1 or later).

Parameters:

Name	Type	Description	Required
projectId	Int	The ID of the project the configurations are associated with	YES

Returns:

• List<Configuration>

Example:

val someProjectId = 1
val configurationsList = Configuration().getConfigs(someProjectId)

 

POST Requests:

---

1. addConfigGroup

Description:

Creates a new configuration group (requires TestRail 5.2 or later).

Required Parameters:

• projectId
• name

Returns:

• Configuration

Example:

val configurationGroupFoo = Configuration(
        projectId = 1,
        name = "My Configuration Group"
)
configurationGroupFoo.addConfigGroup()

2. addConfig

Description:

Creates a new configuration (requires TestRail 5.2 or later).

Required Parameters:

• groupId
• name

Returns:

• Configuration

Example:

val configurationFoo = Configuration(
        groupId = 1,
        name = "My Configuration"
)
configurationFoo.addConfig()

3. updateConfigGroup

Description:

Updates an existing configuration group (requires TestRail 5.2 or later).

Required Parameters:

• id

Returns:

• Configuration

Example:

val configurationGroupFoo = Configuration(
        id = 1,
        name = "My Updated Configuration Group"
)
configurationGroupFoo.updateConfigGroup()

4. updateConfig

Description:

Updates an existing configuration (requires TestRail 5.2 or later).

Required Parameters:

• id

Returns:

• Configuration

Example:

val configurationFoo = Configuration(
        id = 1,
        name = "My Updated Configuration"
)
configurationFoo.updateConfig()

5. deleteConfigGroup

Description:

Deletes an existing configuration group and its configurations (requires TestRail 5.2 or later).

Required Parameters:

• id

Example:

val configurationGroupFoo = Configuration(
        id = 1
)
configurationGroupFoo.deleteConfigGroup()

6. deleteConfig

Description:

Deletes an existing configuration (requires TestRail 5.2 or later).

Required Parameters:

• id

Example:

val configurationFoo = Configuration(
        id = 1
)
configurationFoo.deleteConfig()