Resultsummarybypipeline - Query

Reference

Service:: Test Results

API Version:: 7.2-preview.1

Get summary of test results.

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

With optional parameters:

GET https://vstmr.dev.azure.com/{organization}/{project}/_apis/testresults/resultsummarybypipeline?pipelineId={pipelineId}&stageName={stageName}&phaseName={phaseName}&jobName={jobName}&includeFailureDetails={includeFailureDetails}&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.
pipelineId	query	True	integer int32	Pipeline Id. This is same as build Id.
includeFailureDetails	query		boolean	If true returns failure insights
jobName	query		string	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.
phaseName	query		string	Name of the phase. Maximum supported length for name is 256 character.
stageName	query		string	Name of the stage. Maximum supported length for name is 256 character.

Responses

Name	Type	Description
200 OK	TestResultSummary	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name	Description
AggregatedResultsAnalysis
AggregatedResultsByOutcome
AggregatedResultsDifference
AggregatedRunsByOutcome
AggregatedRunsByState
BuildReference	Reference to a build.
JobReference	Job in pipeline. This is related to matrixing in YAML.
PhaseReference	Phase in pipeline
PipelineReference	Pipeline reference
ProjectState
ProjectVisibility
ReleaseReference	Reference to a release.
StageReference	Stage in pipeline
TeamProjectReference
TestCaseResultIdentifier	Reference to a test result.
TestFailureDetails
TestFailuresAnalysis
TestOutcome
TestResultsContext
TestResultsContextType
TestResultSummary
TestRunOutcome
TestRunState

AggregatedResultsAnalysis

Name	Type	Description
duration	string
notReportedResultsByOutcome	<string, AggregatedResultsByOutcome>
previousContext	TestResultsContext
resultsByOutcome	<string, AggregatedResultsByOutcome>
resultsDifference	AggregatedResultsDifference
runSummaryByOutcome	<string, AggregatedRunsByOutcome>
runSummaryByState	<string, AggregatedRunsByState>
totalTests	integer

AggregatedResultsByOutcome

Name	Type	Description
count	integer
duration	string
groupByField	string
groupByValue	object
outcome	TestOutcome
rerunResultCount	integer

AggregatedResultsDifference

Name	Type	Description
increaseInDuration	string
increaseInFailures	integer
increaseInNonImpactedTests	integer
increaseInOtherTests	integer
increaseInPassedTests	integer
increaseInTotalTests	integer

AggregatedRunsByOutcome

Name	Type	Description
outcome	TestRunOutcome
runsCount	integer

AggregatedRunsByState

Name	Type	Description
resultsByOutcome	<string, AggregatedResultsByOutcome>
runsCount	integer
state	TestRunState

BuildReference

Reference to a build.

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

JobReference

Job in pipeline. This is related to matrixing in YAML.

Name	Type	Description
attempt	integer	Attempt number of the job
jobName	string	Matrixing in YAML generates copies of a job with different inputs in matrix. JobName is the name of those input. Maximum supported length for name is 256 character.

PhaseReference

Phase in pipeline

Name	Type	Description
attempt	integer	Attempt number of the phase
phaseName	string	Name of the phase. Maximum supported length for name is 256 character.

PipelineReference

Pipeline reference

Name	Type	Description
jobReference	JobReference	Reference of the job
phaseReference	PhaseReference	Reference of the phase.
pipelineDefinitionId	integer	Reference of the BuildDefinitionId.
pipelineId	integer	Reference of the pipeline with which this pipeline instance is related.
stageReference	StageReference	Reference of the stage.

ProjectState

Name	Type	Description
all	string
createPending	string
deleted	string
deleting	string
new	string
unchanged	string
wellFormed	string

ProjectVisibility

Name	Type	Description
private	string
public	string

ReleaseReference

Reference to a release.

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

StageReference

Stage in pipeline

Name	Type	Description
attempt	integer	Attempt number of stage
stageName	string	Name of the stage. Maximum supported length for name is 256 character.

TeamProjectReference

Name	Type	Description
abbreviation	string
defaultTeamImageUrl	string
description	string
id	string
lastUpdateTime	string
name	string
revision	integer
state	ProjectState
url	string
visibility	ProjectVisibility

TestCaseResultIdentifier

Reference to a test result.

Name	Type	Description
testResultId	integer	Test result ID.
testRunId	integer	Test run ID.

TestFailureDetails

Name	Type	Description
count	integer
testResults	TestCaseResultIdentifier[]	Reference to a test result.

TestFailuresAnalysis

Name	Type	Description
existingFailures	TestFailureDetails
fixedTests	TestFailureDetails
newFailures	TestFailureDetails
previousContext	TestResultsContext

TestOutcome

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

TestResultsContext

Name	Type	Description
build	BuildReference	Reference to a build.
contextType	TestResultsContextType
pipelineReference	PipelineReference	Pipeline reference
release	ReleaseReference	Reference to a release.

TestResultsContextType

Name	Type	Description
build	string
pipeline	string
release	string

TestResultSummary

Name	Type	Description
aggregatedResultsAnalysis	AggregatedResultsAnalysis
noConfigRunsCount	integer
teamProject	TeamProjectReference
testFailures	TestFailuresAnalysis
testResultsContext	TestResultsContext
totalRunsCount	integer

TestRunOutcome

Name	Type	Description
failed	string	Run with at-least one failed test.
notImpacted	string	Run with no impacted tests.
others	string	Runs with All tests in other category.
passed	string	Run with zero failed tests and has at least one impacted test

TestRunState

Name	Type	Description
aborted	string	Run is stopped and remaining tests have been aborted
completed	string	All tests have completed or been skipped.
inProgress	string	Tests are running.
needsInvestigation	string	Run requires investigation because of a test point failure This is a legacy state and should not be used any more
notStarted	string	The run is still being created. No tests have started yet.
unspecified	string	Only used during an update to preserve the existing value.
waiting	string	Run is currently initializing This is a legacy state and should not be used any more

Share via