通过

Iterations - Get

  • 参考
服务:
Work
API 版本:
7.1

按 iterationId 获取团队的迭代

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

URI 参数

名称 在 必需 类型 说明
id
 path True

string (uuid)

迭代的 ID
organization
 path True

string

Azure DevOps 组织的名称。
project
 path True

string

项目 ID 或项目名称
team
 path

string

团队 ID 或团队名称
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

响应

名称 类型 说明
200 OK

TeamSettingsIteration

成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

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

示例

Get a team's iteration by iterationId

示例请求

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations/{id}?api-version=7.1

示例响应

状态代码:
200 
{
  "id": "a589a806-bf11-4d4f-a031-c19813331553",
  "name": "Sprint 2",
  "path": "Fabrikam-Fiber\\Release 1\\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",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553"
    },
    "project": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e"
    },
    "team": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e/teams/748b18b6-4b3c-425a-bcae-ff9b3e703012"
    },
    "teamSettings": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings"
    },
    "teamIterations": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations"
    },
    "capacity": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553/capacities"
    },
    "classificationNode": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/_apis/wit/classificationNodes/Iterations/Release%201/Sprint%202"
    },
    "teamDaysOff": {
      "href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553/teamdaysoff"
    }
  }
}

定义

名称 说明
ReferenceLinks

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

表示单个迭代的浅表 ref。
TimeFrame

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

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

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

TeamIterationAttributes

Object
名称 类型 说明
finishDate

string (date-time)

完成迭代的日期。 仅日期，在 UTC 午夜更正未调整。
startDate

string (date-time)

迭代的开始日期。 仅日期，在 UTC 午夜更正未调整。
timeFrame

TimeFrame

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

TeamSettingsIteration

Object

表示单个迭代的浅表 ref。

名称 类型 说明
_links

ReferenceLinks

与资源相关的链接集合
attributes

TeamIterationAttributes

迭代的属性，例如开始日期和结束日期。
id

string (uuid)

迭代的 ID。
name

string

迭代的名称。
path

string

迭代的相对路径。
url

string

指向资源的完整 http 链接

TimeFrame

枚举

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

值 说明
current
future
past