Work Item Types Field - Get

Service:

Work Item Tracking

API Version:

7.1-preview.3

Obtenga un campo para un tipo de elemento de trabajo con referencias detalladas.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?api-version=7.1-preview.3

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}/fields/{field}?$expand={$expand}&api-version=7.1-preview.3

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
field	path	True	string
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
type	path	True	string	Tipo de elemento de trabajo.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.3" para usar esta versión de la API.
$expand	query		WorkItemTypeFieldsExpandLevel	Expanda el nivel de la respuesta de la API. Propiedades: para incluir valores permitidos, valor predeterminado, isRequired, etc. como parte de la respuesta; Ninguno: para omitir estas propiedades.

Respuestas

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

Ejemplos

Get project scoped work item type field data

Get project scoped work item type field data with expand option

Get project scoped work item type field data

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.IterationPath?api-version=7.1-preview.3

Sample Response

Status code:

200

{
  "helpText": "The iteration within which this bug will be fixed",
  "alwaysRequired": false,
  "defaultValue": null,
  "referenceName": "System.IterationPath",
  "name": "Iteration Path",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Get project scoped work item type field data with expand option

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/Bug/fields/System.ChangedBy?$expand=All&api-version=7.1-preview.3

Sample Response

Status code:

200

{
  "alwaysRequired": false,
  "defaultValue": null,
  "allowedValues": [
    {
      "displayName": "Jamal Hartnett",
      "id": "df828ec3-71d8-6e69-9afd-e736c5a32145",
      "uniqueName": "fabrikamfiber4@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmItYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNCFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    },
    {
      "displayName": "Norman Paulk",
      "id": "df828ec3-71d8-6e69-9afd-e736c5b32145",
      "uniqueName": "Fabrikamfiber16@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmIeYWIwNC00ZWM0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    },
    {
      "displayName": "Chuck Reinhart",
      "id": "df828ec3-71d8-6e69-9afd-g736c5a32145",
      "uniqueName": "fabrikamfiber3@hotmail.com",
      "descriptor": "s2s.M2FjODRhZmItYWIwNC00SWG0LWEyZWItOGEyYWJmNGJlNDQ3QDcyZjk4OGJmLTg2ZjEtNDFhZi05MWFiLTJkN2NkMDExZGI0Nw"
    }
  ],
  "dependentFields": [],
  "referenceName": "System.ChangedBy",
  "name": "Changed By",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.ChangedBy"
}

Definiciones

Nombre	Description
WorkItemFieldReference	Referencia a un campo de un elemento de trabajo
WorkItemTypeFieldsExpandLevel	Expanda el nivel de la respuesta de la API. Propiedades: para incluir valores permitidos, valor predeterminado, isRequired, etc. como parte de la respuesta; Ninguno: para omitir estas propiedades.
WorkItemTypeFieldWithReferences	Instancia de campo de un workItemype con referencias detalladas.

WorkItemFieldReference

Referencia a un campo de un elemento de trabajo

Nombre	Tipo	Description
name	string	Nombre descriptivo del campo.
referenceName	string	Nombre de referencia del campo.
url	string	Dirección URL de REST del recurso.

WorkItemTypeFieldsExpandLevel

Expanda el nivel de la respuesta de la API. Propiedades: para incluir valores permitidos, valor predeterminado, isRequired, etc. como parte de la respuesta; Ninguno: para omitir estas propiedades.

Nombre	Tipo	Description
all	string	Incluye valores permitidos y campos dependientes del campo.
allowedValues	string	Incluye los valores permitidos para el campo.
dependentFields	string	Incluye campos dependientes del campo.
none	string	Incluye solo las propiedades básicas del campo.

WorkItemTypeFieldWithReferences

Instancia de campo de un workItemype con referencias detalladas.

Nombre	Tipo	Description
allowedValues	object[]	Lista de valores permitidos de campo.
alwaysRequired	boolean	Indica si el valor de campo siempre es necesario.
defaultValue	object	Representa el valor predeterminado del campo.
dependentFields	WorkItemFieldReference[]	Lista de campos dependientes.
helpText	string	Obtiene el texto de ayuda del campo.
name	string	Nombre descriptivo del campo.
referenceName	string	Nombre de referencia del campo.
url	string	Dirección URL de REST del recurso.