Fields - Update

Referencia

Servicio:: Work Item Tracking

Versión de la API:: 7.1

Actualice un campo.

PATCH 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/nombre de referencia del campo que se va a actualizar
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.

Cuerpo de la solicitud

Nombre	Tipo	Description
isDeleted	boolean	Indica si el usuario quiere restaurar el campo.
isLocked	boolean	Indica si el usuario quiere bloquear el campo.

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_write	Concede la capacidad de leer, crear y actualizar elementos de trabajo y consultas, actualizar metadatos del panel de actualización, áreas de lectura e iteraciones rutas de acceso a otros metadatos relacionados con el seguimiento de elementos de trabajo, ejecutar consultas y recibir notificaciones sobre eventos de elemento de trabajo a través de enlaces de servicio.

Ejemplos

Set field locked

Undelete a field

Set field locked

Solicitud de ejemplo

HTTP

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

{
  "isLocked": true
}

Respuesta de muestra

status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

Solicitud de ejemplo

HTTP

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

{
  "isDeleted": false
}

Respuesta de muestra

status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Definiciones

Nombre	Description
FieldType	Tipo del campo.
FieldUpdate	Describe una solicitud de actualización para un campo de elemento de trabajo.
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.

FieldUpdate

Object

Describe una solicitud de actualización para un campo de elemento de trabajo.

Nombre	Tipo	Description
isDeleted	boolean	Indica si el usuario quiere restaurar el campo.
isLocked	boolean	Indica si el usuario quiere bloquear el campo.

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.

ReferenceLinks

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.

Compartir a través de

Fields - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Set field locked

Solicitud de ejemplo

Respuesta de muestra

Undelete a field

Solicitud de ejemplo

Respuesta de muestra

Definiciones

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Recursos adicionales