Classification Nodes - Get

Service:

Work Item Tracking

API Version:

5.0

获取给定节点路径的分类节点。

GET https://dev.azure.com/{organization}/{project}/_apis/wit/classificationnodes/{structureGroup}/{path}?api-version=5.0

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
structureGroup	path	True	TreeStructureGroup	分类节点、区域或迭代的结构组。
path	path		string	分类节点的路径。
api-version	query	True	string	要使用的 API 版本。 应将其设置为“5.0”才能使用此版本的 API。
$depth	query		integer int32	要提取的子级的深度。

响应

名称	类型	说明
200 OK	WorkItemClassificationNode	成功的操作

安全性

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

名称	说明
vso.work	授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Get an area

Get an iteration

Get an area

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "id": 126391,
  "identifier": "d5d98099-47ac-468a-9579-c059c90bf7c5",
  "name": "Web",
  "structureType": "area",
  "hasChildren": false,
  "_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

HTTP

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

Sample Response

Status code:

200

{
  "id": 126392,
  "identifier": "dd643523-4d15-4106-a6a4-e70d39a09446",
  "name": "Final Iteration",
  "structureType": "iteration",
  "hasChildren": false,
  "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"
}

定义

名称	说明
ReferenceLinks	表示 REST 引用链接集合的类。
TreeNodeStructureType	节点结构类型。
TreeStructureGroup	分类节点、区域或迭代的结构组。
WorkItemClassificationNode	定义工作项跟踪的分类节点。

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

TreeNodeStructureType

节点结构类型。

名称	类型	说明
area	string	区域类型。
iteration	string	迭代类型。

TreeStructureGroup

分类节点、区域或迭代的结构组。

名称	类型	说明
areas	string
iterations	string

WorkItemClassificationNode

定义工作项跟踪的分类节点。

名称	类型	说明
_links	ReferenceLinks	链接对相关 REST 资源的引用。
attributes	object	具有节点属性（例如迭代节点的开始/完成日期）的字典。
children	WorkItemClassificationNode[]	提取的子节点列表。
hasChildren	boolean	指示分类节点是否具有任何子节点的标志。
id	integer	分类节点的整数 ID。
identifier	string	分类节点的 GUID ID。
name	string	分类节点的名称。
structureType	TreeNodeStructureType	节点结构类型。
url	string