GetTestcaseFieldConfig,Get test case field configuration - Alibaba Cloud DevOps

Service endpoint and authorization

Obtain a service endpoint: Replace {domain} in the API request syntax.
Obtain a personal access token.

Product	Resource	Required permission
Test Management	Test Case Field Configuration	Read-only

Request syntax

Region edition

GET https://{domain}/oapi/v1/testhub/testRepos/{id}/testcases/fields

Request header

Parameter	Type	Required	Description	Example value
x-yunxiao-token	string	Yes	The personal access token.	pt-0fh3**0fbG_35af**0484

Request parameters

Parameter	Type	Location	Required	Description	Example value
id	string	path	Yes	The unique identifier of the test case repository.

Request example

Region edition

curl -X 'GET' \
  'https://{domain}/oapi/v1/testhub/testRepos/{id}/testcases/fields' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter	Type	Description	Example value
-	array	The array of field configurations.
-	object	A field configuration object.
cascadingOptions	object	The options for a cascading field.
mustSelectLeaf	boolean	Indicates whether a leaf node must be selected.	true
optionsList	array	The list of options.	[]
-	object	An option object.
children	array[string]	The child nodes of the option.
defaultValue	string	The default value of the field.	12233
description	string	The description of the field.	Description
format	string	The field format. Valid values: `list` (single-select), `multiList` (multi-select), `date`, `dateTime`, `int` (integer), `float`, `string` (single-line text), `text` (multi-line text), `user`, `multiUser` (multi-select user), `cascading` (cascading field), `file`, `tag`, `sprint` (iteration), and `version`.	list
id	string	The ID of the field.	field-id-xxx
name	string	The name of the field.	Name
options	array	The available options for the field.
-	object	An option object.
displayValue	string	The display value of the option.	111
id	string	The ID of the option.	field-id-xxx
value	string	The actual value of the option.	111
valueEn	string	The English value of the option.	111
required	boolean	Indicates whether the field is required.	true
showWhenCreate	boolean	Indicates whether the field appears during test case creation.	true
type	string	The field type. Valid values: `NativeField` (native field) and `CustomField` (custom field).	NativeField

Response example

[
    {
        "cascadingOptions": {
            "mustSelectLeaf": true,
            "optionsList": []
        },
        "defaultValue": "12233",
        "description": "Description",
        "format": "list",
        "id": "field-id-xxx",
        "name": "Name",
        "options": [
            {
                "displayValue": "111",
                "id": "field-id-xxx",
                "value": "111",
                "valueEn": "111"
            }
        ],
        "required": true,
        "showWhenCreate": true,
        "type": "NativeField"
    }
]

Error codes

For API error codes, see the Error Code Center.