Resultdetailsbyrelease - Get

Service:

Test Results

API Version:

7.1-preview.1

GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultdetailsbyrelease?releaseId={releaseId}&releaseEnvId={releaseEnvId}&api-version=7.1-preview.1

With optional parameters:

GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultdetailsbyrelease?releaseId={releaseId}&releaseEnvId={releaseEnvId}&publishContext={publishContext}&groupBy={groupBy}&$filter={$filter}&$orderby={$orderby}&shouldIncludeResults={shouldIncludeResults}&queryRunSummaryForInProgress={queryRunSummaryForInProgress}&api-version=7.1-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.1-preview.1' to use this version of the api.
releaseEnvId	query	True	integer (int32)
releaseId	query	True	integer (int32)
$filter	query		string
$orderby	query		string
groupBy	query		string
publishContext	query		string
queryRunSummaryForInProgress	query		boolean
shouldIncludeResults	query		boolean

Responses

Name	Type	Description
200 OK	TestResultsDetails	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
AggregatedResultsByOutcome
BuildReference	Reference to a build.
CustomTestField	A custom field information. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)
FailingSince	Failing since information of a test result.
IdentityRef
ReferenceLinks
ReleaseReference	Reference to a release.
ResultGroupType	Hierarchy type of the result, default value of None means its leaf node.
ShallowReference	An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.
SharedStepModel	Reference to shared step workitem.
TestActionResultModel	Represents a test step result.
TestCaseResult	Represents a test result.
TestCaseResultAttachmentModel	Test attachment information in a test iteration.
TestCaseResultIdentifier	Reference to a test result.
TestIterationDetailsModel	Represents a test iteration result.
TestOutcome
TestResultParameterModel	Test parameter information in a test iteration.
TestResultsDetails
TestResultsDetailsForGroup
TestSubResult	Represents a sub result of a test result.

AggregatedResultsByOutcome

Object

Name	Type	Description
count	integer (int32)
duration	string (TimeSpan)
groupByField	string
groupByValue	object
outcome	TestOutcome
rerunResultCount	integer (int32)

BuildReference

Object

Reference to a build.

Name	Type	Description
branchName	string	Branch name.
buildSystem	string	Build system.
definitionId	integer (int32)	Build Definition ID.
id	integer (int32)	Build ID.
number	string	Build Number.
repositoryId	string	Repository ID.
uri	string	Build URI.

CustomTestField

Object

A custom field information. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)

Name	Type	Description
fieldName	string	Field Name.
value	object	Field value.

FailingSince

Object

Failing since information of a test result.

Name	Type	Description
build	BuildReference	Build reference since failing.
date	string (date-time)	Time since failing(UTC).
release	ReleaseReference	Release reference since failing.

IdentityRef

Object

Name	Type	Description
_links	ReferenceLinks
descriptor	string
directoryAlias	string
displayName	string
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string

ReferenceLinks

Object

Name	Type	Description
links	object

ReleaseReference

Object

Reference to a release.

Name	Type	Description
attempt	integer (int32)	Number of Release Attempt.
creationDate	string (date-time)	Release Creation Date(UTC).
definitionId	integer (int32)	Release definition ID.
environmentCreationDate	string (date-time)	Environment creation Date(UTC).
environmentDefinitionId	integer (int32)	Release environment definition ID.
environmentDefinitionName	string	Release environment definition name.
environmentId	integer (int32)	Release environment ID.
environmentName	string	Release environment name.
id	integer (int32)	Release ID.
name	string	Release name.

ResultGroupType

Enumeration

Hierarchy type of the result, default value of None means its leaf node.

Value	Description
none	Leaf node of test result.
rerun	Hierarchy type of test result.
dataDriven	Hierarchy type of test result.
orderedTest	Hierarchy type of test result.
generic	Unknown hierarchy type.

ShallowReference

Object

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

Name	Type	Description
id	string	ID of the resource
name	string	Name of the linked resource (definition name, controller name, etc.)
url	string	Full http link to the resource

SharedStepModel

Object

Reference to shared step workitem.

Name	Type	Description
id	integer (int32)	WorkItem shared step ID.
revision	integer (int32)	Shared step workitem revision.

TestActionResultModel

Object

Represents a test step result.

Name	Type	Description
actionPath	string	Path identifier for test step in test case workitem. Note: 1) It is represented in Hexadecimal format with 8 digits for a step. 2) Internally, the step ID value for first step starts with 2 so actionPath = 00000002 step 9, will have an ID = 10 and actionPath = 0000000a step 15, will have an ID =16 and actionPath = 00000010 3) actionPath of shared step is concatenated with the parent step of test case. Example, it would be something of type - 0000000300000001 where 00000003 denotes action path of test step and 00000001 denotes action path for shared step
comment	string	Comment in result.
completedDate	string (date-time)	Time when execution completed(UTC).
durationInMs	number (double)	Duration of execution.
errorMessage	string	Error message in result.
iterationId	integer (int32)	Iteration ID of test action result.
outcome	string	Test outcome of result.
sharedStepModel	SharedStepModel	Reference to shared step workitem.
startedDate	string (date-time)	Time when execution started(UTC).
stepIdentifier	string	This is step Id of test case. For shared step, it is step Id of shared step in test case workitem; step Id in shared step. Example: TestCase workitem has two steps: 1) Normal step with Id = 1 2) Shared Step with Id = 2. Inside shared step: a) Normal Step with Id = 1 Value for StepIdentifier for First step: "1" Second step: "2;1"
url	string	Url of test action result. Deprecated in hosted environment.

TestCaseResult

Object

Represents a test result.

Name	Type	Description
afnStripId	integer (int32)	Test attachment ID of action recording.
area	ShallowReference	Reference to area path of test.
associatedBugs	ShallowReference[]	Reference to bugs linked to test result.
automatedTestId	string	ID representing test method in a dll.
automatedTestName	string	Fully qualified name of test executed.
automatedTestStorage	string	Container to which test belongs.
automatedTestType	string	Type of automated test.
automatedTestTypeId	string	TypeId of automated test.
build	ShallowReference	Shallow reference to build associated with test result.
buildReference	BuildReference	Reference to build associated with test result.
comment	string	Comment in a test result with maxSize= 1000 chars.
completedDate	string (date-time)	Time when test execution completed(UTC). Completed date should be greater than StartedDate.
computerName	string	Machine name where test executed.
configuration	ShallowReference	Reference to test configuration. Type ShallowReference.
createdDate	string (date-time)	Timestamp when test result created(UTC).
customFields	CustomTestField[]	Additional properties of test result.
durationInMs	number (double)	Duration of test execution in milliseconds. If not provided value will be set as CompletedDate - StartedDate
errorMessage	string	Error message in test execution.
failingSince	FailingSince	Information when test results started failing.
failureType	string	Failure type of test result. Valid Value= (Known Issue, New Issue, Regression, Unknown, None)
id	integer (int32)	ID of a test result.
iterationDetails	TestIterationDetailsModel[]	Test result details of test iterations used only for Manual Testing.
lastUpdatedBy	IdentityRef	Reference to identity last updated test result.
lastUpdatedDate	string (date-time)	Last updated datetime of test result(UTC).
outcome	string	Test outcome of test result. Valid values = (Unspecified, None, Passed, Failed, Inconclusive, Timeout, Aborted, Blocked, NotExecuted, Warning, Error, NotApplicable, Paused, InProgress, NotImpacted)
owner	IdentityRef	Reference to test owner.
priority	integer (int32)	Priority of test executed.
project	ShallowReference	Reference to team project.
release	ShallowReference	Shallow reference to release associated with test result.
releaseReference	ReleaseReference	Reference to release associated with test result.
resetCount	integer (int32)	ResetCount.
resolutionState	string	Resolution state of test result.
resolutionStateId	integer (int32)	ID of resolution state.
resultGroupType	ResultGroupType	Hierarchy type of the result, default value of None means its leaf node.
revision	integer (int32)	Revision number of test result.
runBy	IdentityRef	Reference to identity executed the test.
stackTrace	string	Stacktrace with maxSize= 1000 chars.
startedDate	string (date-time)	Time when test execution started(UTC).
state	string	State of test result. Type TestRunState.
subResults	TestSubResult[]	List of sub results inside a test result, if ResultGroupType is not None, it holds corresponding type sub results.
testCase	ShallowReference	Reference to the test executed.
testCaseReferenceId	integer (int32)	Reference ID of test used by test result. Type TestResultMetaData
testCaseRevision	integer (int32)	TestCaseRevision Number.
testCaseTitle	string	Name of test.
testPlan	ShallowReference	Reference to test plan test case workitem is part of.
testPoint	ShallowReference	Reference to the test point executed.
testRun	ShallowReference	Reference to test run.
testSuite	ShallowReference	Reference to test suite test case workitem is part of.
url	string	Url of test result.

TestCaseResultAttachmentModel

Object

Test attachment information in a test iteration.

Name	Type	Description
actionPath	string	Path identifier test step in test case workitem.
id	integer (int32)	Attachment ID.
iterationId	integer (int32)	Iteration ID.
name	string	Name of attachment.
size	integer (int64)	Attachment size.
url	string	Url to attachment.

TestCaseResultIdentifier

Object

Reference to a test result.

Name	Type	Description
testResultId	integer (int32)	Test result ID.
testRunId	integer (int32)	Test run ID.

TestIterationDetailsModel

Object

Represents a test iteration result.

Name	Type	Description
actionResults	TestActionResultModel[]	Test step results in an iteration.
attachments	TestCaseResultAttachmentModel[]	Reference to attachments in test iteration result.
comment	string	Comment in test iteration result.
completedDate	string (date-time)	Time when execution completed(UTC).
durationInMs	number (double)	Duration of execution.
errorMessage	string	Error message in test iteration result execution.
id	integer (int32)	ID of test iteration result.
outcome	string	Test outcome if test iteration result.
parameters	TestResultParameterModel[]	Test parameters in an iteration.
startedDate	string (date-time)	Time when execution started(UTC).
url	string	Url to test iteration result.

TestOutcome

Enumeration

Value	Description
unspecified	Only used during an update to preserve the existing value.
none	Test has not been completed, or the test type does not report pass/failure.
passed	Test was executed w/o any issues.
failed	Test was executed, but there were issues. Issues may involve exceptions or failed assertions.
inconclusive	Test has completed, but we can't say if it passed or failed. May be used for aborted tests...
timeout	The test timed out
aborted	Test was aborted. This was not caused by a user gesture, but rather by a framework decision.
blocked	Test had it chance for been executed but was not, as ITestElement.IsRunnable == false.
notExecuted	Test was not executed. This was caused by a user gesture - e.g. user hit stop button.
warning	To be used by Run level results. This is not a failure.
error	There was a system error while we were trying to execute a test.
notApplicable	Test is Not Applicable for execution.
paused	Test is paused.
inProgress	Test is currently executing. Added this for TCM charts
notImpacted	Test is not impacted. Added fot TIA.

TestResultParameterModel

Object

Test parameter information in a test iteration.

Name	Type	Description
actionPath	string	Test step path where parameter is referenced.
iterationId	integer (int32)	Iteration ID.
parameterName	string	Name of parameter.
stepIdentifier	string	This is step Id of test case. For shared step, it is step Id of shared step in test case workitem; step Id in shared step. Example: TestCase workitem has two steps: 1) Normal step with Id = 1 2) Shared Step with Id = 2. Inside shared step: a) Normal Step with Id = 1 Value for StepIdentifier for First step: "1" Second step: "2;1"
url	string	Url of test parameter. Deprecated in hosted environment.
value	string	Value of parameter.

TestResultsDetails

Object

Name	Type	Description
groupByField	string
resultsForGroup	TestResultsDetailsForGroup[]

TestResultsDetailsForGroup

Object

Name	Type	Description
groupByValue	object
results	TestCaseResult[]	Represents a test result.
resultsCountByOutcome	<string,  AggregatedResultsByOutcome>
tags	string[]

TestSubResult

Object

Represents a sub result of a test result.

Name	Type	Description
comment	string	Comment in sub result.
completedDate	string (date-time)	Time when test execution completed(UTC).
computerName	string	Machine where test executed.
configuration	ShallowReference	Reference to test configuration.
customFields	CustomTestField[]	Additional properties of sub result.
displayName	string	Name of sub result.
durationInMs	integer (int64)	Duration of test execution.
errorMessage	string	Error message in sub result.
id	integer (int32)	ID of sub result.
lastUpdatedDate	string (date-time)	Time when result last updated(UTC).
outcome	string	Outcome of sub result.
parentId	integer (int32)	Immediate parent ID of sub result.
resultGroupType	ResultGroupType	Hierarchy type of the result, default value of None means its leaf node.
sequenceId	integer (int32)	Index number of sub result.
stackTrace	string	Stacktrace.
startedDate	string (date-time)	Time when test execution started(UTC).
subResults	TestSubResult[]	List of sub results inside a sub result, if ResultGroupType is not None, it holds corresponding type sub results.
testResult	TestCaseResultIdentifier	Reference to test result.
url	string	Url of sub result.