Points - List
Get a list of test points.
GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points?api-version=5.0
GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points?witFields={witFields}&configurationId={configurationId}&testCaseId={testCaseId}&testPointIds={testPointIds}&includePointDetails={includePointDetails}&$skip={$skip}&$top={$top}&api-version=5.0
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
plan
|
path | True |
integer int32 |
ID of the test plan. |
project
|
path | True |
string |
Project ID or project name |
suite
|
path | True |
integer int32 |
ID of the suite that contains the points. |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '5.0' to use this version of the api. |
$skip
|
query |
integer int32 |
Number of test points to skip.. |
|
$top
|
query |
integer int32 |
Number of test points to return. |
|
configuration
|
query |
string |
Get test points for specific configuration. |
|
include
|
query |
boolean |
Include all properties for the test point. |
|
test
|
query |
string |
Get test points for a specific test case, valid when configurationId is not set. |
|
test
|
query |
string |
Get test points for comma-separated list of test point IDs, valid only when configurationId and testCaseId are not set. |
|
wit
|
query |
string |
Comma-separated list of work item field names. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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. |
Examples
A page at a time |
By configuration |
By test case |
Specific points |
With details |
With fields |
A page at a time
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?$skip=1&$top=1&api-version=5.0
Sample Response
{
"value": [
{
"id": 2,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/2",
"assignedTo": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "4"
},
"lastResult": {
"id": "100001"
},
"outcome": "Failed",
"state": "NotReady",
"testCase": {
"id": "40",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 1
}
By configuration
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?configurationId=2&api-version=5.0
Sample Response
{
"value": [
{
"id": 1,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/1",
"assignedTo": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "28"
},
"lastResult": {
"id": "100000"
},
"outcome": "Passed",
"state": "Completed",
"testCase": {
"id": "39",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
},
{
"id": 2,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/2",
"assignedTo": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "4"
},
"lastResult": {
"id": "100001"
},
"outcome": "Failed",
"state": "NotReady",
"testCase": {
"id": "40",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 2
}
By test case
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?testCaseId=39&api-version=5.0
Sample Response
{
"value": [
{
"id": 1,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/1",
"assignedTo": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "28"
},
"lastResult": {
"id": "100000"
},
"outcome": "Passed",
"state": "Completed",
"testCase": {
"id": "39",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 1
}
Specific points
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?testPointIds=1,2&api-version=5.0
Sample Response
{
"value": [
{
"id": 1,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/1",
"assignedTo": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "28"
},
"lastResult": {
"id": "100000"
},
"outcome": "Passed",
"state": "Completed",
"testCase": {
"id": "39",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
},
{
"id": 2,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/2",
"assignedTo": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "4"
},
"lastResult": {
"id": "100001"
},
"outcome": "Failed",
"state": "NotReady",
"testCase": {
"id": "40",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 2
}
With details
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?includePointDetails=true&api-version=5.0
Sample Response
{
"value": [
{
"id": 1,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/1",
"assignedTo": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett",
"uniqueName": "fabrikamfiber4@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"failureType": "None",
"lastTestRun": {
"id": "28",
"name": "sprint1 (Manual)",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/28"
},
"lastResult": {
"id": "100000",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/28/Results/100000"
},
"lastUpdatedDate": "2014-05-28T16:14:41.393Z",
"lastUpdatedBy": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett",
"uniqueName": "fabrikamfiber4@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff"
},
"outcome": "Passed",
"revision": 22,
"state": "Completed",
"suite": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
},
"testCase": {
"id": "39",
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/39",
"webUrl": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=39"
},
"testPlan": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
},
{
"id": 2,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/2",
"assignedTo": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"failureType": "None",
"lastTestRun": {
"id": "4",
"name": "sprint1 (Manual)",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/4"
},
"lastResult": {
"id": "100001",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/4/Results/100001"
},
"lastUpdatedDate": "2014-05-04T13:18:11.043Z",
"lastUpdatedBy": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"outcome": "Failed",
"revision": 1,
"state": "NotReady",
"suite": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1"
},
"testCase": {
"id": "40",
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/40",
"webUrl": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=40"
},
"testPlan": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
},
"workItemProperties": [
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 2
}
With fields
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points?witFields=System.Title,System.Reason&api-version=5.0
Sample Response
{
"value": [
{
"id": 1,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/1",
"assignedTo": {
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"displayName": "Jamal Hartnett"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "28"
},
"lastResult": {
"id": "100000"
},
"outcome": "Passed",
"state": "Completed",
"testCase": {
"id": "39",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "System.Title",
"value": "Shopping cart"
}
},
{
"workItem": {
"key": "System.Reason",
"value": "New"
}
},
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
},
{
"id": 2,
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/Points/2",
"assignedTo": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber"
},
"configuration": {
"id": "2",
"name": "Windows 8"
},
"lastTestRun": {
"id": "4"
},
"lastResult": {
"id": "100001"
},
"outcome": "Failed",
"state": "NotReady",
"testCase": {
"id": "40",
"url": null,
"webUrl": null
},
"workItemProperties": [
{
"workItem": {
"key": "System.Title",
"value": "Price check"
}
},
{
"workItem": {
"key": "System.Reason",
"value": "New"
}
},
{
"workItem": {
"key": "Microsoft.VSTS.TCM.AutomationStatus",
"value": "Not Automated"
}
}
]
}
],
"count": 2
}
Definitions
Name | Description |
---|---|
Identity |
|
Last |
|
Reference |
The class to represent a collection of REST reference links. |
Shallow |
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. |
Test |
Test point. |
Work |
IdentityRef
Name | Type | Description |
---|---|---|
_links |
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 |
|
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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
This url is the full route to the source resource of this graph subject. |
LastResultDetails
Name | Type | Description |
---|---|---|
dateCompleted |
string |
|
duration |
integer |
|
runBy |
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. |
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.
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 |
TestPoint
Test point.
Name | Type | Description |
---|---|---|
assignedTo |
AssignedTo. Type IdentityRef. |
|
automated |
boolean |
Automated. |
comment |
string |
Comment associated with test point. |
configuration |
Configuration. Type ShallowReference. |
|
failureType |
string |
Failure type of test point. |
id |
integer |
ID of the test point. |
lastResetToActive |
string |
Last date when test point was reset to Active. |
lastResolutionStateId |
integer |
Last resolution state id of test point. |
lastResult |
Last result of test point. Type ShallowReference. |
|
lastResultDetails |
Last result details of test point. Type LastResultDetails. |
|
lastResultState |
string |
Last result state of test point. |
lastRunBuildNumber |
string |
LastRun build number of test point. |
lastTestRun |
Last testRun of test point. Type ShallowReference. |
|
lastUpdatedBy |
Test point last updated by. Type IdentityRef. |
|
lastUpdatedDate |
string |
Last updated date of test point. |
outcome |
string |
Outcome of test point. |
revision |
integer |
Revision number. |
state |
string |
State of test point. |
suite |
Suite of test point. Type ShallowReference. |
|
testCase |
TestCase associated to test point. Type WorkItemReference. |
|
testPlan |
TestPlan of test point. Type ShallowReference. |
|
url |
string |
Test point Url. |
workItemProperties |
object[] |
Work item properties of test point. |
WorkItemReference
Name | Type | Description |
---|---|---|
id |
string |
|
name |
string |
|
type |
string |
|
url |
string |
|
webUrl |
string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for