Share via

Result Meta Data - Update

Service:
Test Results
API Version:
7.1-preview.4

Update properties of test result meta data

PATCH https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/results/resultmetadata/{testCaseReferenceId}?api-version=7.1-preview.4

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
testCaseReferenceId
 path True

integer (int32)

TestCaseReference Id of Test Result to be updated.
api-version
 query True

string

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

Request Body

Name Type Description
flakyIdentifiers

TestFlakyIdentifier[]

List of Flaky Identifiers

Responses

Name Type Description
200 OK

TestResultMetaData

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_write Grants the ability to read, create, and update test plans, cases, results and other test management related artifacts.

Examples

Update test result metadata

Sample request

PATCH https://vstmr.dev.azure.com/fabrikam/Fabrikam/_apis/testresults/results/resultmetadata/1?api-version=7.1-preview.4

{
  "flakyIdentifiers": [
    {
      "branchName": "refs/heads/master",
      "isFlaky": true
    }
  ]
}

Sample response

Status code:
200 
{
  "testCaseReferenceId": 1,
  "priority": 0
}

Definitions

Name Description
TestFlakyIdentifier

Test Flaky Identifier
TestResultMetaData

Represents a Meta Data of a test result.
TestResultMetaDataUpdateInput

Represents a TestResultMetaData Input

TestFlakyIdentifier

Object

Test Flaky Identifier

Name Type Description
branchName

string

Branch Name where Flakiness has to be Marked/Unmarked
isFlaky

boolean

State for Flakiness

TestResultMetaData

Object

Represents a Meta Data of a test result.

Name Type Description
automatedTestName

string

AutomatedTestName of test result.
automatedTestStorage

string

AutomatedTestStorage of test result.
flakyIdentifiers

TestFlakyIdentifier[]

List of Flaky Identifier for TestCaseReferenceId
owner

string

Owner of test result.
priority

integer (int32)

Priority of test result.
testCaseReferenceId

integer (int32)

ID of TestCaseReference.
testCaseTitle

string

TestCaseTitle of test result.

TestResultMetaDataUpdateInput

Object

Represents a TestResultMetaData Input

Name Type Description
flakyIdentifiers

TestFlakyIdentifier[]

List of Flaky Identifiers