Compartir a través de

Fields - Get

  • Referencia
Servicio:
Work Item Tracking
Versión de la API:
7.1

Obtiene información sobre un campo específico.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

Parámetros de identificador URI

Nombre En Requerido Tipo Description
fieldNameOrRefName
 path True

string

Nombre simple de campo o nombre de referencia
organization
 path True

string

Nombre de la organización de Azure DevOps.
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 "7.1" para usar esta versión de la API.

Respuestas

Nombre Tipo Description
200 OK

WorkItemField2

operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

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, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

Gets information on a specific field

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

Respuesta de muestra

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://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Definiciones

Nombre Description
FieldType

Tipo del campo.
FieldUsage

El uso del campo.
ReferenceLinks

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

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

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

FieldType

Enumeración

Tipo del campo.

Valor Description
boolean

Tipo de campo booleano.
dateTime

Tipo de campo Datetime.
double

Tipo de campo doble.
guid

Tipo de campo guid.
history

Tipo de campo Historial.
html

Tipo de campo HTML (multilínea).
identity

Tipo de campo de identidad.
integer

Tipo de campo entero.
picklistDouble

Tipo de campo de lista de selección doble. Al crear un campo de lista de selección doble desde la API REST, use "Double" FieldType.
picklistInteger

Tipo de campo picklist entero. Al crear un campo de lista desplegable de enteros desde la API REST, use "Integer" FieldType.
picklistString

Tipo de campo picklist de cadena. Al crear un campo de lista desplegable de cadenas desde la API REST, use "String" FieldType.
plainText

Tipo de campo de texto sin formato.
string

Tipo de campo de cadena.
treePath

Tipo de campo Treepath.

FieldUsage

Enumeración

El uso del campo.

Valor Description
none

Uso vacío.
tree

Uso del campo Treenode.
workItem

Uso del campo de elemento de trabajo.
workItemLink

Uso del campo de vínculo de elemento de trabajo.
workItemTypeExtension

Uso de la extensión de tipo de elemento de trabajo.
Object

Clase que representa una colección de vínculos de referencia 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.

WorkItemField2

Object

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

Nombre Tipo Description
_links

ReferenceLinks

Vincular referencias a recursos REST relacionados.
canSortBy

boolean

Indica si el campo se puede ordenar en las consultas del servidor.
description

string

Descripción del campo.
isDeleted

boolean

Indica si se elimina este campo.
isIdentity

boolean

Indica si este campo es un campo de identidad.
isLocked

boolean

Indica si este campo está marcado como bloqueado para su edición.
isPicklist

boolean

Indica si esta instancia es picklist.
isPicklistSuggested

boolean

Indica si esta instancia es una lista de selección sugerida.
isQueryable

boolean

Indica si el campo se puede consultar en el servidor.
name

string

Nombre del campo.
picklistId

string (uuid)

Si este campo es picklist, el identificador de la lista de selección asociada; de lo contrario, null
readOnly

boolean

Indica si el campo es [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

El uso del campo.

WorkItemFieldOperation

Object

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

Nombre Tipo Description
name

string

Nombre descriptivo de la operación.
referenceName

string

Nombre de referencia de la operación.