Test Point - Get Points

Reference

Service:: Test Plan

API Version:: 7.1

Get a particular Test Point from a suite.

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint?pointId={pointId}&api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestPoint?pointId={pointId}&returnIdentityRef={returnIdentityRef}&includePointDetails={includePointDetails}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
planId	path	True	integer int32	ID of the test plan for which test points are requested.
project	path	True	string	Project ID or project name
suiteId	path	True	integer int32	ID of the test suite for which test points are requested.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.
pointId	query	True	string	ID of test point to be fetched.
includePointDetails	query		boolean	If set to false, will get a smaller payload containing only basic details about the test point object
returnIdentityRef	query		boolean	If set to true, returns the AssignedTo field in TestCaseReference as IdentityRef object.

Responses

Name	Type	Description
200 OK	TestPoint[]	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
FailureType	Failure Type for the Test Point
IdentityRef
LastResolutionState	Last Resolution State Id for the Test Point
LastResultDetails	Last result details of test point.
Outcome	Outcome of the Test Point
PointState	State of the Test Point
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
ResultState	Last Result State of the Test Point
TeamProjectReference	Represents a shallow reference to a TeamProject.
TestCaseReference	Test Case Reference
TestConfigurationReference	Test Configuration Reference
TestPlanReference	The test plan reference resource.
TestPoint	Test Point Class
TestPointResults	Test Point Results
TestSuiteReference	The test suite reference resource.

FailureType

Failure Type for the Test Point

Name	Type	Description
known_Issue	string
maxValue	string
new_Issue	string
none	string
null_Value	string
regression	string
unknown	string

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string	Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string	Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary
inactive	boolean	Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary
isAadIdentity	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecated - not in use in most preexisting implementations of ToIdentityRef
uniqueName	string	Deprecated - use Domain+PrincipalName instead
url	string	This url is the full route to the source resource of this graph subject.

LastResolutionState

Last Resolution State Id for the Test Point

Name	Type	Description
configurationIssue	string
maxValue	string
needsInvestigation	string
none	string
nullValue	string
productIssue	string
testIssue	string

LastResultDetails

Last result details of test point.

Name	Type	Description
dateCompleted	string	Completed date of last result.
duration	integer	Duration of the last result in milliseconds.
runBy	IdentityRef	The user who executed the last result.

Outcome

Outcome of the Test Point

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...
maxValue	string
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.

PointState

State of the Test Point

Name	Type	Description
completed	string	The test has passed successfully and does not need to be re-run for the test pass to be considered complete.
inProgress	string	The test is being executed.
maxValue	string
none	string	Default
notReady	string	The test point needs to be executed but is not able to.
ready	string	The test point needs to be executed in order for the test pass to be considered complete. Either the test has not been run before or the previous run failed.

ProjectState

Project state.

Name	Type	Description
all	string	All projects regardless of state except Deleted.
createPending	string	Project has been queued for creation, but the process has not yet started.
deleted	string	Project has been deleted.
deleting	string	Project is in the process of being deleted.
new	string	Project is in the process of being created.
unchanged	string	Project has not been changed.
wellFormed	string	Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

ResultState

Last Result State of the Test Point

Name	Type	Description
completed	string	Test has completed, but there is no quantitative measure of completeness. This may apply to load tests.
inProgress	string	Test is currently executing.
maxValue	string
paused	string	Test has been paused. This is applicable when a test case is paused by the user (For e.g. Manual Tester can pause the execution of the manual test case)
pending	string	Test is in the execution queue, was not started yet.
queued	string	Test has been queued. This is applicable when a test case is queued for execution
unspecified	string	Only used during an update to preserve the existing value.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name	Type	Description
abbreviation	string	Project abbreviation.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

TestCaseReference

Test Case Reference

Name	Type	Description
assignedTo	IdentityRef	Identity to whom the test case is assigned
id	integer	Test Case Id
name	string	Test Case Name
state	string	State of the test case work item

TestConfigurationReference

Test Configuration Reference

Name	Type	Description
id	integer	Id of the configuration
name	string	Name of the configuration

TestPlanReference

The test plan reference resource.

Name	Type	Description
id	integer	ID of the test plan.
name	string	Name of the test plan.

TestPoint

Test Point Class

Name	Type	Description
comment	string	Comment associated to the Test Point
configuration	TestConfigurationReference	Configuration associated with the Test Point
id	integer	Id of the Test Point
isActive	boolean	Variable to decide whether the test case is Active or not
isAutomated	boolean	Is the Test Point for Automated Test Case or Manual
lastResetToActive	string	Last Reset to Active Time Stamp for the Test Point
lastUpdatedBy	IdentityRef	Last Updated details for the Test Point
lastUpdatedDate	string	Last Update Time Stamp for the Test Point
links	ReferenceLinks	Reference links
project	TeamProjectReference	Project under which the Test Point is
results	TestPointResults	Results associated to the Test Point
testCaseReference	TestCaseReference	Test Case Reference
testPlan	TestPlanReference	Test Plan under which the Test Point is
testSuite	TestSuiteReference	Test Suite under which the Test Point is
tester	IdentityRef	Tester associated with the Test Point

TestPointResults

Test Point Results

Name	Type	Description
failureType	FailureType	Failure Type for the Test Point
lastResolutionState	LastResolutionState	Last Resolution State Id for the Test Point
lastResultDetails	LastResultDetails	Last Result Details for the Test Point
lastResultId	integer	Last Result Id
lastResultState	ResultState	Last Result State of the Test Point
lastRunBuildNumber	string	Last RUn Build Number for the Test Point
lastTestRunId	integer	Last Test Run Id for the Test Point
outcome	Outcome	Outcome of the Test Point
state	PointState	State of the Test Point

TestSuiteReference

The test suite reference resource.

Name	Type	Description
id	integer	ID of the test suite.
name	string	Name of the test suite.

Share via