Fields - Get

Service:

Work Item Tracking

API Version:

4.1

Obtiene información sobre un campo específico.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collection	path	True	string	Nombre de la colección team Foundation Server.
fieldNameOrRefName	path	True	string	Nombre simple de campo o nombre de referencia
instance	path	True	string	Nombre del servidor TFS ({server:port})
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "4.1" para usar esta versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	WorkItemField	operación correcta

Seguridad

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

Nombre	Description
vso.work	Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

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

Definiciones

Nombre	Description
FieldType	Tipo del campo.
FieldUsage	Uso del campo.
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
WorkItemField	Describe un campo en un elemento de trabajo y son propiedades específicas de ese tipo de elemento de trabajo.
WorkItemFieldOperation	Describe una operación de campo de elemento de trabajo.

FieldType

Tipo del campo.

Nombre	Tipo	Description
boolean	string	Tipo de campo booleano.
dateTime	string	Tipo de campo Datetime.
double	string	Tipo de campo doble.
guid	string	Tipo de campo guid.
history	string	Tipo de campo Historial.
html	string	Tipo de campo HTML (multilínea).
identity	string	Tipo de campo de identidad.
integer	string	Tipo de campo entero.
picklistDouble	string	Tipo de campo de lista desplegable doble.
picklistInteger	string	Tipo de campo de lista desplegable de enteros.
picklistString	string	Tipo de campo de lista desplegable de cadenas.
plainText	string	Tipo de campo de texto sin formato.
string	string	Tipo de campo de cadena.
treePath	string	Tipo de campo Treepath.

FieldUsage

Uso del campo.

Nombre	Tipo	Description
none	string	Uso vacío.
tree	string	Uso del campo Treenode.
workItem	string	Uso de campos de elemento de trabajo.
workItemLink	string	Uso del campo de vínculo de elemento de trabajo.
workItemTypeExtension	string	Uso de la extensión de tipo de elemento de trabajo.

ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

WorkItemField

Describe un campo en un elemento de trabajo y son propiedades específicas de ese tipo de elemento de trabajo.

Nombre	Tipo	Description
_links	ReferenceLinks	Vincular referencias a recursos REST relacionados.
description	string	Descripción del campo.
isIdentity	boolean	Indica si este campo es un campo de identidad.
isPicklist	boolean	Indica si esta instancia es picklist.
isPicklistSuggested	boolean	Indica si esta instancia es una lista desplegable sugerida.
name	string	Nombre del campo.
readOnly	boolean	Indica si el campo es [de solo lectura].
referenceName	string	Nombre de referencia del campo.
supportedOperations	WorkItemFieldOperation[]	Las operaciones admitidas en este campo.
type	FieldType	Tipo del campo.
url	string
usage	FieldUsage	Uso del campo.

WorkItemFieldOperation

Describe una operación de campo de elemento de trabajo.

Nombre	Tipo	Description
name	string	Nombre de la operación.
referenceName	string	Nombre de referencia de la operación.