Fields - Get

Service:

Work Item Tracking

API Version:

4.1

Obtém informações sobre um campo específico.

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
collection	path	True	string	O nome da coleção team foundation server.
fieldNameOrRefName	path	True	string	Nome simples do campo ou nome de referência
instance	path	True	string	Nome do servidor TFS ({server:port})
project	path		string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '4.1' para usar essa versão da api.

Respostas

Nome	Tipo	Description
200 OK	WorkItemField	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 e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Sample Request

HTTP

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Sample Response

Status code:

200

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://fabrikam:8080/tfs/_apis/wit/fields/System.IterationPath"
}

Definições

Nome	Description
FieldType	O tipo do campo.
FieldUsage	O uso do campo.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
WorkItemField	Descreve um campo em um item de trabalho e suas propriedades são específicas para esse tipo de item de trabalho.
WorkItemFieldOperation	Descreve uma operação de campo de item de trabalho.

FieldType

O tipo do campo.

Nome	Tipo	Description
boolean	string	Tipo de campo booliano.
dateTime	string	Tipo de campo datetime.
double	string	Tipo de campo duplo.
guid	string	Tipo de campo guid.
history	string	Tipo de campo histórico.
html	string	Tipo de campo HTML (multilinha).
identity	string	Tipo de campo de identidade.
integer	string	Tipo de campo inteiro.
picklistDouble	string	Tipo de campo de lista de seleção dupla.
picklistInteger	string	Tipo de campo de lista de seleção inteiro.
picklistString	string	Tipo de campo de lista de seleção de cadeia de caracteres.
plainText	string	Tipo de campo de texto sem formatação.
string	string	Tipo de campo de cadeia de caracteres.
treePath	string	Tipo de campo Treepath.

FieldUsage

O uso do campo.

Nome	Tipo	Description
none	string	Uso vazio.
tree	string	Uso do campo Treenode.
workItem	string	Uso do campo de item de trabalho.
workItemLink	string	Uso do campo de link do item de trabalho.
workItemTypeExtension	string	Uso da Extensão de Tipo de Item de Trabalho.

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.

WorkItemField

Descreve um campo em um item de trabalho e suas propriedades são específicas para esse tipo de item de trabalho.

Nome	Tipo	Description
_links	ReferenceLinks	Vincular referências a recursos REST relacionados.
description	string	A descrição do campo.
isIdentity	boolean	Indica se esse campo é um campo de identidade.
isPicklist	boolean	Indica se essa instância é uma lista de seleção.
isPicklistSuggested	boolean	Indica se essa instância é uma lista de seleção sugerida.
name	string	O nome do campo.
readOnly	boolean	Indica se o campo é [somente leitura].
referenceName	string	O nome de referência do campo.
supportedOperations	WorkItemFieldOperation[]	As operações com suporte neste campo.
type	FieldType	O tipo do campo.
url	string
usage	FieldUsage	O uso do campo.

WorkItemFieldOperation

Descreve uma operação de campo de item de trabalho.

Nome	Tipo	Description
name	string	Nome da operação.
referenceName	string	Nome de referência da operação.