Extensionfields - Query

Returns List of custom test fields for the given custom test field scope.

GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/extensionfields?scopeFilter={scopeFilter}&api-version=7.2-preview.1

URI Parameters

Name In Required Type Description
organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

api-version
query True

string

Version of the API to use. This should be set to '7.2-preview.1' to use this version of the api.

scopeFilter
query True

CustomTestFieldScope

Scope of custom test fields which are to be returned.

Responses

Name Type Description
200 OK

CustomTestFieldDefinition[]

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.test Grants the ability to read test plans, cases, results and other test management related artifacts.

Definitions

Name Description
CustomTestFieldDefinition

Data structure which stores details for the customTestFields to be updated

CustomTestFieldScope

Artifact to which customTestField will be set.

CustomTestFieldType

Data type of the customTestField.

CustomTestFieldDefinition

Data structure which stores details for the customTestFields to be updated

Name Type Description
fieldId

integer

ID assigned to the custom test field upon creation, should be left empty when creating.

fieldName

string

The name of custom field cannot be longer than 50 characters (spaces, numbers, and special characters are not allowed) and must be unique in the project. The names are case insensitive.

fieldType

CustomTestFieldType

Data type of the customTestField.

scope

CustomTestFieldScope

Artifact to which customTestField will be set.

CustomTestFieldScope

Artifact to which customTestField will be set.

Value Description
all
none
system

Reserved for internal Azure DevOps functionality. Not to be used.

testResult

Custom field can be used with TestResult artifact.

testRun

Custom field can be used with TestRun artifact.

testRunAndTestResult

Custom test field can be used with either TestRun or TestResult artifact.

CustomTestFieldType

Data type of the customTestField.

Value Description
bit

Boolean data type.

dateTime

Datetime data type.

float

Floating integer data type.

guid

Unique identifier data type.

int

Integer data type.

string

String data type.