Compartir a través de


Fields - Update

Actualizar un campo.

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

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

El 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-preview.3" 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

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_write Concede la capacidad de leer, crear y actualizar elementos de trabajo y consultas, actualizar metadatos de panel, á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 elementos de trabajo a través de enlaces de servicio.

Ejemplos

Set field locked
Undelete a field

Set field locked

Sample Request

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

{
  "isLocked": true
}

Sample Response

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

Sample Request

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

{
  "isDeleted": false
}

Sample Response

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 se va a representar una colección de vínculos de referencia de REST.

WorkItemField2

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 de selección doble. Al crear un campo de lista de selección doble desde la API REST, use "Double" FieldType.

picklistInteger

string

Tipo de campo de lista de selección de enteros. Al crear un campo de lista de selección de enteros a partir de la API REST, use "Integer" FieldType.

picklistString

string

Tipo de campo de lista de selección de cadena. Al crear un campo de lista de selección de cadena desde la API REST, use "String" FieldType.

plainText

string

Tipo de campo de texto sin formato.

string

string

Tipo de campo de cadena.

treePath

string

Tipo de campo Treepath.

FieldUpdate

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

El 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.

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre Tipo Description
links

object

Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

WorkItemField2

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.

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 está seleccionada.

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

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

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.