Share via

Classification Nodes - Get

  • Reference
Service:
Work Item Tracking
API Version:
6.0

Gets the classification node for a given node path.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path}?api-version=6.0
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path}?$depth={$depth}&api-version=6.0

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
structureGroup
 path True

TreeStructureGroup

Structure group of the classification node, area or iteration.
path
 path

string

Path of the classification node.
api-version
 query True

string

Version of the API to use. This should be set to '6.0' to use this version of the api.
$depth
 query

integer

int32

Depth of children to fetch.

Responses

Name Type Description
200 OK

WorkItemClassificationNode

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.work Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Examples

Get an area
Get an iteration

Get an area

Sample request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/classificationnodes/Areas?api-version=6.0

Sample response

Status code:
200 
{
  "id": 126391,
  "identifier": "d5d98099-47ac-468a-9579-c059c90bf7c5",
  "name": "Web",
  "structureType": "area",
  "hasChildren": false,
  "path": "\\fabrikam\\fiber\\tfvc\\iteration",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Areas/Web"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Areas"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Areas/Web"
}

Get an iteration

Sample request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/classificationnodes/Iterations?api-version=6.0

Sample response

Status code:
200 
{
  "id": 126392,
  "identifier": "dd643523-4d15-4106-a6a4-e70d39a09446",
  "name": "Final Iteration",
  "structureType": "iteration",
  "hasChildren": false,
  "path": "\\fabrikam\\fiber\\tfvc\\iteration",
  "attributes": {
    "startDate": "2014-10-27T00:00:00Z",
    "finishDate": "2014-10-31T00:00:00Z"
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Iterations/Final%20Iteration"
    },
    "parent": {
      "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Iterations"
    }
  },
  "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/classificationNodes/Iterations/Final%20Iteration"
}

Definitions

Name Description
ReferenceLinks

The class to represent a collection of REST reference links.
TreeNodeStructureType

Node structure type.
TreeStructureGroup

Structure group of the classification node, area or iteration.
WorkItemClassificationNode

Defines a classification node for work item tracking.

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.

TreeNodeStructureType

Node structure type.

Name Type Description
area

string

Area type.
iteration

string

Iteration type.

TreeStructureGroup

Structure group of the classification node, area or iteration.

Name Type Description
areas

string

iterations

string

WorkItemClassificationNode

Defines a classification node for work item tracking.

Name Type Description
_links

ReferenceLinks

Link references to related REST resources.
attributes

object

Dictionary that has node attributes like start/finish date for iteration nodes.
children

WorkItemClassificationNode[]

List of child nodes fetched.
hasChildren

boolean

Flag that indicates if the classification node has any child nodes.
id

integer

Integer ID of the classification node.
identifier

string

GUID ID of the classification node.
name

string

Name of the classification node.
path

string

Path of the classification node.
structureType

TreeNodeStructureType

Node structure type.
url

string