Compartilhar via

Backlogs - Get Backlog

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

Obter um nível de pendência

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
 path True

string

A ID do nível de backlog
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 True

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

BacklogLevelConfiguration

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 backlog

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "id": "Microsoft.FeatureCategory",
  "name": "Features",
  "rank": 3,
  "workItemCountLimit": 1000,
  "addPanelFields": [
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    }
  ],
  "columnFields": [
    {
      "columnFieldReference": {
        "referenceName": "System.WorkItemType",
        "name": "Work Item Type",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "System.Title",
        "name": "Title",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
      },
      "width": 400
    },
    {
      "columnFieldReference": {
        "referenceName": "System.State",
        "name": "State",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Scheduling.Effort",
        "name": "Effort",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.Effort"
      },
      "width": 50
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Common.BusinessValue",
        "name": "Business Value",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.BusinessValue"
      },
      "width": 50
    },
    {
      "columnFieldReference": {
        "referenceName": "Microsoft.VSTS.Common.ValueArea",
        "name": "Value Area",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
      },
      "width": 100
    },
    {
      "columnFieldReference": {
        "referenceName": "System.Tags",
        "name": "Tags",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
      },
      "width": 200
    }
  ],
  "workItemTypes": [
    {
      "name": "Feature",
      "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
    }
  ],
  "defaultWorkItemType": {
    "name": "Feature",
    "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
  },
  "color": "773B93",
  "isHidden": false,
  "type": "portfolio"
}

Definições

Nome Description
BacklogColumn
BacklogLevelConfiguration
BacklogType

O tipo desse nível de backlog
WorkItemFieldReference

Referência a um campo em um item de trabalho
WorkItemTypeReference

Referência a um tipo de item de trabalho.

BacklogColumn

Objeto
Nome Tipo Description
columnFieldReference

WorkItemFieldReference

Referência a um campo em um item de trabalho
width

integer (int32)

BacklogLevelConfiguration

Objeto
Nome Tipo Description
addPanelFields

WorkItemFieldReference[]

Lista de campos a serem incluídos no Painel de Adição
color

string

Cor do nível de backlog
columnFields

BacklogColumn[]

Lista padrão de colunas para a lista de pendências
defaultWorkItemType

WorkItemTypeReference

Tipo de item de trabalho padrão para a lista de pendências
id

string

ID de backlog (para o nível de backlog herdado da configuração do processo, pode ser o nome categoryref)
isHidden

boolean

Indica se o nível de backlog está oculto
name

string

Nome da caixa de fundo
rank

integer (int32)

Classificação de lista de pendências (Taskbacklog é 0)
type

BacklogType

O tipo desse nível de backlog
workItemCountLimit

integer (int32)

Número máximo de itens de trabalho a serem mostrados na lista de pendências fornecida
workItemTypes

WorkItemTypeReference[]

Os tipos de Item de Trabalho que participam dessa lista de pendências, como conhecido pelo projeto/processo, podem ser substituídos pelas configurações da equipe para bugs

BacklogType

Enumeração

O tipo desse nível de backlog

Valor Description
portfolio

Nível de backlog do portfólio
requirement

Nível de pendência de requisito
task

Nível de lista de pendências da tarefa

WorkItemFieldReference

Objeto

Referência a um campo em um item de trabalho

Nome Tipo Description
name

string

O nome amigável do campo.
referenceName

string

O nome de referência do campo.
url

string

A URL REST do recurso.

WorkItemTypeReference

Objeto

Referência a um tipo de item de trabalho.

Nome Tipo Description
name

string

Nome do tipo de item de trabalho.
url

string