Compartilhar via


Fields - Update

Atualizar um campo.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
fieldNameOrRefName
path True

string

Nome/nome de referência do campo a ser atualizado

organization
path True

string

O nome da organização do Azure DevOps.

project
path

string

ID do projeto ou nome do projeto

api-version
query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar essa versão da API.

Corpo da solicitação

Nome Tipo Description
isDeleted

boolean

Indica se o usuário deseja restaurar o campo.

isLocked

boolean

Indica se o usuário deseja bloquear o campo.

Respostas

Nome Tipo Description
200 OK

WorkItemField2

operação bem-sucedida

Segurança

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

Nome Description
vso.work_write Concede a capacidade de ler, criar e atualizar itens de trabalho e consultas, atualizar metadados do quadro, ler caminhos de área e iterações de outros itens de trabalho que acompanham metadados relacionados, executar consultas e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

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

Definições

Nome Description
FieldType

O tipo do campo.

FieldUpdate

Descreve uma solicitação de atualização para um campo de item de trabalho.

FieldUsage

O uso do campo.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

WorkItemField2

Descreve um campo em um item de trabalho e suas propriedades específicas para esse tipo de item de trabalho.

WorkItemFieldOperation

Descreve uma operação de campo de item de trabalho.

FieldType

O tipo do campo.

Nome Tipo Description
boolean

string

Tipo de campo booliano.

dateTime

string

Tipo de campo datetime.

double

string

Tipo de campo duplo.

guid

string

Tipo de campo guid.

history

string

Tipo de campo histórico.

html

string

Tipo de campo HTML (várias linhas).

identity

string

Tipo de campo de identidade.

integer

string

Tipo de campo inteiro.

picklistDouble

string

Tipo de campo de lista de seleção dupla. Ao criar um campo de lista de seleção dupla da API REST, use "Double" FieldType.

picklistInteger

string

Tipo de campo de lista de seleção de inteiros. Ao criar um campo de lista de seleção de inteiros da API REST, use "Integer" FieldType.

picklistString

string

Tipo de campo de lista de seleção de cadeia de caracteres. Ao criar um campo de lista de seleção de cadeia de caracteres da API REST, use "String" FieldType.

plainText

string

Tipo de campo de texto sem formatação.

string

string

Tipo de campo de cadeia de caracteres.

treePath

string

Tipo de campo treepath.

FieldUpdate

Descreve uma solicitação de atualização para um campo de item de trabalho.

Nome Tipo Description
isDeleted

boolean

Indica se o usuário deseja restaurar o campo.

isLocked

boolean

Indica se o usuário deseja bloquear o campo.

FieldUsage

O uso do campo.

Nome Tipo Description
none

string

Uso vazio.

tree

string

Uso do campo treenode.

workItem

string

Uso do campo de item de trabalho.

workItemLink

string

Uso do campo de link do item de trabalho.

workItemTypeExtension

string

Uso da extensão de tipo de item de trabalho.

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

WorkItemField2

Descreve um campo em um item de trabalho e suas propriedades específicas para esse tipo de item de trabalho.

Nome Tipo Description
_links

ReferenceLinks

Vincular referências a recursos REST relacionados.

canSortBy

boolean

Indica se o campo é classificável em consultas de servidor.

description

string

A descrição do campo.

isDeleted

boolean

Indica se esse campo foi excluído.

isIdentity

boolean

Indica se esse campo é um campo de identidade.

isLocked

boolean

Indica se esse campo está marcado como bloqueado para edição.

isPicklist

boolean

Indica se essa instância é uma lista de seleção.

isPicklistSuggested

boolean

Indica se essa instância é uma lista de seleção sugerida.

isQueryable

boolean

Indica se o campo pode ser consultado no servidor.

name

string

O nome do campo.

picklistId

string

Se esse campo for picklist, o identificador da lista de seleção associada, caso contrário, nulo

readOnly

boolean

Indica se o campo é [somente leitura].

referenceName

string

O nome de referência do campo.

supportedOperations

WorkItemFieldOperation[]

As operações com suporte neste campo.

type

FieldType

O tipo do campo.

url

string

usage

FieldUsage

O uso do campo.

WorkItemFieldOperation

Descreve uma operação de campo de item de trabalho.

Nome Tipo Description
name

string

Nome amigável da operação.

referenceName

string

Nome de referência da operação.