Partilhar via


Boards - Get

Obter quadro

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
path True

string

identificador para board, nome de nível de lista de pendências do quadro (por exemplo: "Histórias") ou ID

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.

Respostas

Nome Tipo Description
200 OK

Board

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.

Definições

Nome Description
Board
BoardColumn
BoardColumnType
BoardFields
BoardRow
FieldReference

Uma referência abstrata a um campo

ReferenceLinks

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

Board

Nome Tipo Description
_links

ReferenceLinks

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

allowedMappings

object

canEdit

boolean

columns

BoardColumn[]

fields

BoardFields

id

string

ID do recurso

isValid

boolean

name

string

Nome do recurso

revision

integer

rows

BoardRow[]

url

string

Link http completo para o recurso

BoardColumn

Nome Tipo Description
columnType

BoardColumnType

description

string

id

string

isSplit

boolean

itemLimit

integer

name

string

stateMappings

object

BoardColumnType

Nome Tipo Description
inProgress

string

incoming

string

outgoing

string

BoardFields

Nome Tipo Description
columnField

FieldReference

Uma referência abstrata a um campo

doneField

FieldReference

Uma referência abstrata a um campo

rowField

FieldReference

Uma referência abstrata a um campo

BoardRow

Nome Tipo Description
color

string

id

string

name

string

FieldReference

Uma referência abstrata a um campo

Nome Tipo Description
referenceName

string

fieldRefName para o campo

url

string

Link http completo para obter mais informações sobre o campo

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.