Compartilhar via

Teamsettings - Get

  • Referência
Serviço:
Work
Versão da API:
7.1

Obter as configurações de uma equipe

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
team
 path

string

ID da equipe ou nome da equipe
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.

Respostas

Nome Tipo Description
200 OK

TeamSetting

operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome Description
vso.work Concede a capacidade de ler itens de trabalho, consultas, placas, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Get team settings for a team

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
      }
    ]
  }
}

Definições

Nome Description
BugsBehavior

Comportamento de bugs
DayOfWeek

Dias em que a equipe está trabalhando
ReferenceLinks

A classe para representar uma coleção de links de referência REST.
TeamIterationAttributes
TeamSetting

Contrato de dados para TeamSettings
TeamSettingsIteration

Representa um ref superficial para uma única iteração.
TimeFrame

Período de tempo da iteração, como passado, atual ou futuro.

BugsBehavior

Enumeração

Comportamento de bugs

Valor Description
asRequirements
asTasks
off

DayOfWeek

Enumeração

Dias em que a equipe está trabalhando

Valor Description
friday
monday
saturday
sunday
thursday
tuesday
wednesday
Objeto

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

TeamIterationAttributes

Objeto
Nome Tipo Description
finishDate

string (date-time)

Data de término da iteração. Somente data, correto não ajustado à meia-noite em UTC.
startDate

string (date-time)

Data de início da iteração. Somente data, correto não ajustado à meia-noite em UTC.
timeFrame

TimeFrame

Período de tempo da iteração, como passado, atual ou futuro.

TeamSetting

Objeto

Contrato de dados para TeamSettings

Nome Tipo Description
_links

ReferenceLinks

Coleção de links relevantes para o recurso
backlogIteration

TeamSettingsIteration

Iteração de pendências
backlogVisibilities

object

Informações sobre categorias visíveis no backlog.
bugsBehavior

BugsBehavior

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

TeamSettingsIteration

Iteração padrão, a iteração usada ao criar um novo item de trabalho na página de consultas.
defaultIterationMacro

string

Macro de iteração padrão (se houver)
url

string

Link http completo para o recurso
workingDays

DayOfWeek[]

Dias em que a equipe está trabalhando

TeamSettingsIteration

Objeto

Representa um ref superficial para uma única iteração.

Nome Tipo Description
_links

ReferenceLinks

Coleção de links relevantes para o recurso
attributes

TeamIterationAttributes

Atributos da iteração, como data de início e término.
id

string (uuid)

ID da iteração.
name

string

Nome da iteração.
path

string

Caminho relativo da iteração.
url

string

Link http completo para o recurso

TimeFrame

Enumeração

Período de tempo da iteração, como passado, atual ou futuro.

Valor Description
current
future
past