Partager via

Iterations - Get

  • Référence
Service:
Work
Version d'API:
7.1

Obtenir l’itération de l’équipe par itérationId

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

Paramètres URI

Nom Dans Obligatoire Type Description
id
 path True

string (uuid)

ID de l’itération
organization
 path True

string

Nom de l’organisation Azure DevOps.
project
 path True

string

ID de projet ou nom du projet
team
 path

string

ID d’équipe ou nom de l’équipe
api-version
 query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.

Réponses

Nom Type Description
200 OK

TeamSettingsIteration

opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.work Octroie la possibilité de lire des éléments de travail, des requêtes, des tableaux, des zones et des itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Get a team's iteration by iterationId

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
    }
  }
}

Définitions

Nom Description
ReferenceLinks

Classe à représenter une collection de liens de référence REST.
TeamIterationAttributes
TeamSettingsIteration

Représente une ref superficielle pour une seule itération.
TimeFrame

Délai d’itération, tel que passé, actuel ou futur.
Object

Classe à représenter une collection de liens de référence REST.

Nom Type Description
links

object

Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TeamIterationAttributes

Object
Nom Type Description
finishDate

string (date-time)

Date de fin de l’itération. Date seule, correcte non ajustée à minuit au format UTC.
startDate

string (date-time)

Date de début de l’itération. Date seule, correcte non ajustée à minuit au format UTC.
timeFrame

TimeFrame

Délai d’itération, tel que passé, actuel ou futur.

TeamSettingsIteration

Object

Représente une ref superficielle pour une seule itération.

Nom Type Description
_links

ReferenceLinks

Collection de liens pertinents pour la ressource
attributes

TeamIterationAttributes

Attributs de l’itération, tels que la date de début et de fin.
id

string (uuid)

ID de l’itération.
name

string

Nom de l’itération.
path

string

Chemin relatif de l’itération.
url

string

Lien http complet vers la ressource

TimeFrame

Énumération

Délai d’itération, tel que passé, actuel ou futur.

Valeur Description
current
future
past