Iterations - List

Referência

Service:: Work

API Version:: 7.1-preview.1

Obter iterações de uma equipe usando o filtro de período de tempo

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

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-preview.1' para usar essa versão da API.
$timeframe	query		string	Um filtro para o qual as iterações são retornadas com base no tempo relativo. Atualmente, há suporte apenas para Current.

Respostas

Nome	Tipo	Description
200 OK	TeamSettingsIteration[]	operação bem-sucedida

Segurança

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

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, quadros, 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 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"
    }
  ]
}

Definições

Nome	Description
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
TeamIterationAttributes
TeamSettingsIteration	Representa um ref superficial para uma única iteração.
TimeFrame	Período de tempo da iteração, como passado, atual ou futuro.

ReferenceLinks

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

Nome	Tipo	Description
finishDate	string	Data de término da iteração. Somente data, correto não ajustado à meia-noite em UTC.
startDate	string	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.

TeamSettingsIteration

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

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

Nome	Tipo	Description
current	string
future	string
past	string

Compartilhar via