PlanEntry

Overview

A test plan entry is a special type of test run that is created from a test plan.

Fields

Name	Type	Description	Request Methods
id	String	The unique ID of the plan entry	updatePlanEntry, deletePlanEntry
planId	Int	The ID of the plan related to the plan entry	addPlanEntry, updatePlanEntry, deletePlanEntry
suiteId	Int	The ID of the test suite for the test run(s)	addPlanEntry
configIds	List<Int>	An array of configuration IDs used for the test runs of the test plan entry (requires TestRail 3.1 or later)	addPlanEntry
runs	List<Run>	An array of test runs with configurations, please see the example below for details (requires TestRail 3.1 or later)	addPlanEntry
name	String	The name of the test run(s)	addPlanEntry, updatePlanEntry
description	String	The description of the test run(s) (requires TestRail 5.2 or later)	addPlanEntry, updatePlanEntry
assignedToId	Int	The ID of the user the test run(s) should be assigned to	addPlanEntry, updatePlanEntry
includeAll	Boolean	True for including all test cases of the test suite and false for a custom case selection (default: true)	addPlanEntry, updatePlanEntry
caseIds	List<Int>	An array of case IDs for the custom case selection	addPlanEntry, updatePlanEntry

Methods

POST Requests:

---

1. addPlanEntry

Description:

Adds one or more new test runs to a test plan.

Required Parameters:

• planId
• suiteid

Returns:

• PlanEntry

Example:

val somePlanEntry = PlanEntry(
    planId = 1,
    suiteId = 1,
    name = "My Plan Entry"
)
somePlanEntry.addPlanEntry()

 

2. updatePlanEntry

Description:

Updates one or more existing test runs in a plan (partial updates are supported, i.e. you can submit and update specific fields only).

Required Parameters:

• planId
• entryId

Returns:

• PlanEntry

Example:

val somePlanEntry = PlanEntry(
    planId = 1,
    entryId = 1,
    name = "My Updated Plan Entry"
)
somePlanEntry.updatePlanEntry()

 

3. deletePlanEntry

Description:

Deletes one or more existing test runs from a plan.

Required Parameters:

• planId
• entryId

Example:

val somePlanEntry = PlanEntry(
    planId = 1,
    entryId = 1
)
somePlanEntry.deletePlanEntry()