Iterations - List

参考

Service:: Work

API Version:: 7.1-preview.1

使用时间范围筛选器获取团队的迭代

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?$timeframe={$timeframe}&api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
team	path		string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。
$timeframe	query		string	基于相对时间返回迭代的筛选器。目前仅支持 Current。

响应

名称	类型	说明
200 OK	TeamSettingsIteration[]	成功的操作

安全性

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 a team's iterations using timeframe filter

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations?$timeframe=current&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "values": [
    {
      "id": "a589a806-bf11-4d4f-a031-c19813331553",
      "name": "Sprint 2",
      "attributes": {
        "startDate": null,
        "finishDate": null
      },
      "url": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553"
    }
  ]
}

定义

名称	说明
ReferenceLinks	表示 REST 引用链接集合的类。
TeamIterationAttributes
TeamSettingsIteration	表示单个迭代的浅层引用。
TimeFrame	迭代的时间范围，例如过去、当前或未来。

ReferenceLinks

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

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

TeamIterationAttributes

名称	类型	说明
finishDate	string	完成迭代的日期。仅限日期，在 UTC 午夜未调整正确。
startDate	string	迭代的开始日期。仅限日期，在 UTC 午夜未调整正确。
timeFrame	TimeFrame	迭代的时间范围，例如过去、当前或未来。

TeamSettingsIteration

表示单个迭代的浅层引用。

名称	类型	说明
_links	ReferenceLinks	与资源相关的链接集合
attributes	TeamIterationAttributes	迭代的属性，例如开始和结束日期。
id	string	迭代的 ID。
name	string	迭代的名称。
path	string	迭代的相对路径。
url	string	指向资源的完整 http 链接

TimeFrame

迭代的时间范围，例如过去、当前或未来。

名称	类型	说明
current	string
future	string
past	string

Share via