Teamsettings - Get

服务:

Work

API 版本:

7.1

获取团队的设置

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings?api-version=7.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”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	TeamSetting	成功作

安全性

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 team settings for a team

示例请求

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber/_apis/work/teamsettings?api-version=7.1

示例响应

状态代码:

200

{
  "backlogIteration": {
    "id": "323b04b6-2fb8-4093-94f4-fbe3bd36a19f",
    "name": "Iteration",
    "path": "",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
  },
  "bugsBehavior": "asRequirements",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "backlogVisibilities": {
    "Microsoft.EpicCategory": false,
    "Microsoft.FeatureCategory": true,
    "Microsoft.RequirementCategory": true
  },
  "defaultIteration": {
    "id": "a912d62f-3eba-44b9-ab54-aa82af94b1d7",
    "name": "Iteration 1",
    "path": "\\Iteration 1",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%201"
  },
  "defaultIterationMacro": "@currentIteration",
  "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings"
    },
    "project": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb"
    },
    "team": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/teams/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572"
    },
    "teamIterations": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/iterations"
    },
    "teamFieldValues": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/teamfieldvalues"
    },
    "classificationNode": [
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
      },
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%201"
      }
    ]
  }
}

定义

名称	说明
BugsBehavior	Bug 行为
DayOfWeek	团队工作的日子
ReferenceLinks	表示 REST 引用链接集合的类。
TeamIterationAttributes
TeamSetting	TeamSettings 的数据协定
TeamSettingsIteration	表示单个迭代的浅表 ref。
TimeFrame	迭代的时间范围，例如过去、当前或未来。

BugsBehavior

枚举

Bug 行为

值	说明
asRequirements
asTasks
off

DayOfWeek

枚举

团队工作的日子

值	说明
friday
monday
saturday
sunday
thursday
tuesday
wednesday

ReferenceLinks

Object

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

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

TeamIterationAttributes

Object

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

TeamSetting

Object

TeamSettings 的数据协定

名称	类型	说明
_links	ReferenceLinks	与资源相关的链接集合
backlogIteration	TeamSettingsIteration	积压工作迭代
backlogVisibilities	object	有关积压工作上可见的类别的信息。
bugsBehavior	BugsBehavior	BugsBehavior （Off， AsTasks， AsRequirements， ...）
defaultIteration	TeamSettingsIteration	默认迭代，在查询页上创建新工作项时使用的迭代。
defaultIterationMacro	string	默认迭代宏（如果有）
url	string	指向资源的完整 http 链接
workingDays	DayOfWeek[]	团队工作的日子

TeamSettingsIteration

Object

表示单个迭代的浅表 ref。

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

TimeFrame

枚举

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

值	说明
current
future
past