Partager via

Teamsettings - Get

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

Obtenir les paramètres d’une équipe

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

Paramètres URI

Nom Dans Obligatoire Type Description
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

TeamSetting

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

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
BugsBehavior

Comportement des bogues
DayOfWeek

Jours pendant lesquels l’équipe travaille
ReferenceLinks

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

Contrat de données pour TeamSettings
TeamSettingsIteration

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

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

BugsBehavior

Énumération

Comportement des bogues

Valeur Description
asRequirements
asTasks
off

DayOfWeek

Énumération

Jours pendant lesquels l’équipe travaille

Valeur Description
friday
monday
saturday
sunday
thursday
tuesday
wednesday
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.

TeamSetting

Object

Contrat de données pour TeamSettings

Nom Type Description
_links

ReferenceLinks

Collection de liens pertinents pour la ressource
backlogIteration

TeamSettingsIteration

Itération du backlog
backlogVisibilities

object

Informations sur les catégories visibles sur le backlog.
bugsBehavior

BugsBehavior

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

TeamSettingsIteration

Itération par défaut, itération utilisée lors de la création d’un élément de travail sur la page des requêtes.
defaultIterationMacro

string

Macro itération par défaut (le cas échéant)
url

string

Lien http complet vers la ressource
workingDays

DayOfWeek[]

Jours pendant lesquels l’équipe travaille

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