ResultField

Overview

TestRail currently supports custom fields for two entities, namely for test cases and test results. Custom fields for test cases allow you to add additional details to your test cases. Custom fields for test results can be used to record additional information when test results are entered (for example, on the Add Test Result dialog).

Fields

Name	Type	Description	Request Methods
configs	List<Config>	An object wrapped in an array with two default keys, 'context' and 'options'	getResultFields
description	String	The description for the new custom field	getResultFields
displayOrder	Int	The index of the custom field in the list of other custom fields	getResultFields
id	Int	The unique ID of the result field	getResultFields
label	String	The label for the new custom field	getResultFields
name	String	The name for new the custom field; When creating new custom fields, use simple names without the “custom_” prefix since this will be added automatically.	getResultFields
systemName	String	The unique name of this field in the database. Should be all lower case, no spaces. Please note: this name cannot be changed later.	getResultFields
typeId	Int	The ID of the custom field type	getResultFields
isActive	Boolean	Set flag to true if you want the custom field included for all results. Otherwise (false). Disabling a field can be useful to hide it from TestRail's user interface without the need to delete the project assignments or the entire field (including data).	getResultFields
includeAll	Boolean	Set flag to true if you want the new custom field included for all templates. Otherwise (false) specify the ID's of templates to be included as the next parameter (template_ids)	getResultFields
templateIds	List<Int>	ID's of templates new custom field will apply to if include_all is set to false	getResultFields

Methods

GET Requests:

---

1. getResultFields

Description:

Returns a list of available test result custom fields.

Returns:

• List<ResultField>

Example:

val someResultFieldsList = ResultField().getResultFields()