Teamsettings - Update

參考

Service:: Work

API Version:: 7.1-preview.1

更新小組的設定

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
team	path		string	小組識別碼或小組名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。

要求本文

名稱	類型	Description
backlogIteration	string
backlogVisibilities	object
bugsBehavior	BugsBehavior
defaultIteration	string
defaultIterationMacro	string
workingDays	DayOfWeek[]

回應

名稱	類型	Description
200 OK	TeamSetting	成功的作業

安全性

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

名稱	Description
vso.work_write	授與讀取、建立和更新工作專案和查詢、更新面板中繼資料、讀取區域和反復專案路徑的其他工作專案追蹤相關中繼資料、執行查詢，以及透過服務勾點接收工作專案事件通知的能力。

範例

Update team settings. Example 1

Update team settings. Example 2

Update team settings. Example 1

Sample Request

HTTP

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

{
  "bugsBehavior": "AsTasks",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday"
  ],
  "defaultIteration": "8C2457E8-8936-4CDC-B3AA-17B20F56C76C"
}

Sample Response

Status code:: 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": "asTasks",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday"
  ],
  "backlogVisibilities": {
    "Microsoft.EpicCategory": false,
    "Microsoft.FeatureCategory": true,
    "Microsoft.RequirementCategory": true
  },
  "defaultIteration": {
    "id": "8c2457e8-8936-4cdc-b3aa-17b20f56c76c",
    "name": "Iteration 3",
    "path": "\\Iteration 3",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%203"
  },
  "defaultIterationMacro": null,
  "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%203"
      }
    ]
  }
}

Update team settings. Example 2

Sample Request

HTTP

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

{
  "bugsBehavior": "AsRequirements",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "defaultIterationMacro": "@CurrentIteration"
}

Sample Response

Status code:: 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"
      }
    ]
  }
}

定義

名稱	Description
BugsBehavior	Bug 行為
DayOfWeek	小組正在工作的天數
ReferenceLinks	表示 REST 參考連結集合的類別。
TeamIterationAttributes
TeamSetting	TeamSettings 的資料合約
TeamSettingsIteration	表示單一反復專案的淺層 ref。
TeamSettingsPatch	我們預期在 PATCH 時收到的資料合約
TimeFrame	反復專案的時間範圍，例如過去、目前或未來。

BugsBehavior

Bug 行為

名稱	類型	Description
asRequirements	string
asTasks	string
off	string

DayOfWeek

小組正在工作的天數

名稱	類型	Description
friday	string
monday	string
saturday	string
sunday	string
thursday	string
tuesday	string
wednesday	string

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

TeamIterationAttributes

名稱	類型	Description
finishDate	string	反復專案的完成日期。僅限日期，在 UTC 午夜更正未調整。
startDate	string	反復專案的開始日期。僅限日期，在 UTC 午夜更正未調整。
timeFrame	TimeFrame	反復專案的時間範圍，例如過去、目前或未來。

TeamSetting

TeamSettings 的資料合約

名稱	類型	Description
_links	ReferenceLinks	與資源相關的連結集合
backlogIteration	TeamSettingsIteration	待辦專案反復專案
backlogVisibilities	object	待辦專案上可見類別的相關資訊。
bugsBehavior	BugsBehavior	BugsBehavior (Off、AsTasks、AsRequirements、...)
defaultIteration	TeamSettingsIteration	預設反復專案，這是在查詢頁面上建立新工作專案時所使用的反復專案。
defaultIterationMacro	string	如果有任何) ，則會 (預設反覆運算宏
url	string	資源的完整 HTTP 連結
workingDays	DayOfWeek[]	小組正在工作的天數

TeamSettingsIteration

表示單一反復專案的淺層 ref。

名稱	類型	Description
_links	ReferenceLinks	與資源相關的連結集合
attributes	TeamIterationAttributes	反復專案的屬性，例如開始和結束日期。
id	string	反復專案的識別碼。
name	string	反復專案的名稱。
path	string	反復專案的相對路徑。
url	string	資源的完整 HTTP 連結

TeamSettingsPatch

我們預期在 PATCH 時收到的資料合約

名稱	類型	Description
backlogIteration	string
backlogVisibilities	object
bugsBehavior	BugsBehavior
defaultIteration	string
defaultIterationMacro	string
workingDays	DayOfWeek[]

TimeFrame

反復專案的時間範圍，例如過去、目前或未來。

名稱	類型	Description
current	string
future	string
past	string

共用方式為

Teamsettings - Update

URI 參數

要求本文

回應

安全性

oauth2

Scopes

範例

Update team settings. Example 1

Sample Request

Sample Response

Update team settings. Example 2

Sample Request

Sample Response

定義

BugsBehavior

DayOfWeek

ReferenceLinks

TeamIterationAttributes

TeamSetting

TeamSettingsIteration

TeamSettingsPatch

TimeFrame

其他資源