Iterations - List

Referenz

Service:: Work

API Version:: 7.1-preview.1

Abrufen der Iterationen eines Teams mithilfe des Zeitrahmenfilters

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-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.
$timeframe	query		string	Ein Filter, für den Iterationen basierend auf relativer Zeit zurückgegeben werden. Derzeit wird nur Current unterstützt.

Antworten

Name	Typ	Beschreibung
200 OK	TeamSettingsIteration[]	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	Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Außerdem können Sie Abfragen ausführen, Arbeitselemente durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthaken empfangen.

Beispiele

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

Definitionen

Name	Beschreibung
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
TeamIterationAttributes
TeamSettingsIteration	Stellt einen flachen Ref für eine einzelne Iteration dar.
TimeFrame	Zeitrahmen der Iteration, z. B. Vergangenheit, Aktuelle oder Zukunft.

ReferenceLinks

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.

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

TimeFrame

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

Name	Typ	Beschreibung
current	string
future	string
past	string

Share via