Share via


Teamsettings - Update

Aktualisieren der Einstellungen eines Teams

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

project
path True

string

Projekt-ID oder Projektname

team
path

string

Team-ID oder Teamname

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
backlogIteration

string

backlogVisibilities

object

bugsBehavior

BugsBehavior

defaultIteration

string

defaultIterationMacro

string

workingDays

DayOfWeek[]

Antworten

Name Typ Beschreibung
200 OK

TeamSetting

Erfolgreicher Vorgang

Sicherheit

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

Name Beschreibung
vso.work_write Ermöglicht das Lesen, Erstellen und Aktualisieren von Arbeitselementen und Abfragen, Aktualisieren von Boardmetadaten, Lesebereichs- und Iterationspfaden für andere Metadaten zur Nachverfolgung von Arbeitselementen, Ausführen von Abfragen und das Empfangen von Benachrichtigungen über Arbeitselementereignisse über Diensthaken.

Beispiele

Update team settings. Example 1
Update team settings. Example 2

Update team settings. Example 1

Sample Request

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

{
  "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

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

{
  "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"
      }
    ]
  }
}

Definitionen

Name Beschreibung
BugsBehavior

Fehlerverhalten

DayOfWeek

Tage, an denen das Team arbeitet

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

TeamIterationAttributes
TeamSetting

Datenvertrag für TeamSettings

TeamSettingsIteration

Stellt einen flachen Ref für eine einzelne Iteration dar.

TeamSettingsPatch

Datenvertrag für das, was wir erwarten, wenn PATCH erhalten wird

TimeFrame

Zeitrahmen der Iteration, z. B. Vergangenheit, Aktuelle oder Zukunft.

BugsBehavior

Fehlerverhalten

Name Typ Beschreibung
asRequirements

string

asTasks

string

off

string

DayOfWeek

Tage, an denen das Team arbeitet

Name Typ Beschreibung
friday

string

monday

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TeamIterationAttributes

Name Typ Beschreibung
finishDate

string

Enddatum der Iteration. Nur datumsgeschützt, korrigieren sie unbereinigt um Mitternacht in UTC.

startDate

string

Startdatum der Iteration. Nur datumsgeschützt, korrigieren sie unbereinigt um Mitternacht in UTC.

timeFrame

TimeFrame

Zeitrahmen der Iteration, z. B. Vergangenheit, Aktuelle oder Zukunft.

TeamSetting

Datenvertrag für TeamSettings

Name Typ Beschreibung
_links

ReferenceLinks

Sammlung ressourcenrelevanter Links

backlogIteration

TeamSettingsIteration

Backlogiteration

backlogVisibilities

object

Informationen zu Kategorien, die im Backlog sichtbar sind.

bugsBehavior

BugsBehavior

BugsBehavior (Off, AsTasks, AsRequirements, ...)

defaultIteration

TeamSettingsIteration

Standarditeration, die Iteration, die beim Erstellen eines neuen Arbeitselements auf der Abfrageseite verwendet wird.

defaultIterationMacro

string

Standard-Iterationsmakro (falls vorhanden)

url

string

Vollständiger HTTP-Link zur Ressource

workingDays

DayOfWeek[]

Tage, an denen das Team arbeitet

TeamSettingsIteration

Stellt einen flachen Ref für eine einzelne Iteration dar.

Name Typ Beschreibung
_links

ReferenceLinks

Sammlung ressourcenrelevanter Links

attributes

TeamIterationAttributes

Attribute der Iteration, z. B. Start- und Enddatum.

id

string

ID der Iteration.

name

string

Name der Iteration.

path

string

Relativer Pfad der Iteration.

url

string

Vollständiger HTTP-Link zur Ressource

TeamSettingsPatch

Datenvertrag für das, was wir erwarten, wenn PATCH erhalten wird

Name Typ Beschreibung
backlogIteration

string

backlogVisibilities

object

bugsBehavior

BugsBehavior

defaultIteration

string

defaultIterationMacro

string

workingDays

DayOfWeek[]

TimeFrame

Zeitrahmen der Iteration, z. B. Vergangenheit, Aktuelle oder Zukunft.

Name Typ Beschreibung
current

string

future

string

past

string