Points - Get Point

Service:: Test

API Version:: 7.1

Get a test point.

GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points/{pointIds}?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/test/Plans/{planId}/Suites/{suiteId}/points/{pointIds}?witFields={witFields}&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.
pointIds	path	True	integer (int32)	ID of the test point to get.
project	path	True	string	Project ID or project name
suiteId	path	True	integer (int32)	ID of the suite that contains the point.
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.
witFields	query		string	Comma-separated list of work item field names.

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.

Examples

By id

With fields

By id

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points/{pointIds}?api-version=7.1

Sample response

Status code:: 200

{
  "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"
      }
    }
  ]
}

With fields

Sample request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1/Suites/1/points/{pointIds}?witFields=System.Title,System.Reason&api-version=7.1

Sample response

Status code:: 200

{
  "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": "System.Title",
        "value": "Shopping cart"
      }
    },
    {
      "workItem": {
        "key": "System.Reason",
        "value": "New"
      }
    },
    {
      "workItem": {
        "key": "Microsoft.VSTS.TCM.AutomationStatus",
        "value": "Not Automated"
      }
    }
  ]
}

Definitions

Name	Description
IdentityRef
LastResultDetails	Last result details of test point.
ReferenceLinks	The class to represent a collection of REST reference links.
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.
TestPoint	Test point.
WorkItemReference	WorkItem reference Details.

IdentityRef

Object

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.

LastResultDetails

Object

Last result details of test point.

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

ReferenceLinks

Object

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

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

TestPoint

Object

Test point.

Name	Type	Description
assignedTo	IdentityRef	AssignedTo. Type IdentityRef.
automated	boolean	Automated.
comment	string	Comment associated with test point.
configuration	ShallowReference	Configuration. Type ShallowReference.
failureType	string	Failure type of test point.
id	integer (int32)	ID of the test point.
lastResetToActive	string (date-time)	Last date when test point was reset to Active.
lastResolutionStateId	integer (int32)	Last resolution state id of test point.
lastResult	ShallowReference	Last result of test point. Type ShallowReference.
lastResultDetails	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	ShallowReference	Last testRun of test point. Type ShallowReference.
lastUpdatedBy	IdentityRef	Test point last updated by. Type IdentityRef.
lastUpdatedDate	string (date-time)	Last updated date of test point.
outcome	string	Outcome of test point.
revision	integer (int32)	Revision number.
state	string	State of test point.
suite	ShallowReference	Suite of test point. Type ShallowReference.
testCase	WorkItemReference	TestCase associated to test point. Type WorkItemReference.
testPlan	ShallowReference	TestPlan of test point. Type ShallowReference.
url	string	Test point Url.
workItemProperties	object[]	Work item properties of test point.

WorkItemReference

Object

WorkItem reference Details.

Name	Type	Description
id	string	WorkItem Id.
name	string	WorkItem Name.
type	string	WorkItem Type.
url	string	WorkItem Url. Valid Values : (Bug, Task, User Story, Test Case)
webUrl	string	WorkItem WebUrl.

Share via

Points - Get Point

URI Parameters

Responses

Security

oauth2

Scopes

Examples

By id

Sample request

Sample response

With fields

Sample request

Sample response

Definitions

IdentityRef

LastResultDetails

ReferenceLinks

ShallowReference

TestPoint

WorkItemReference