Compartilhar via

Fields - Update

  • Referência
Serviço:
Work Item Tracking
Versão da API:
7.1

Atualize um campo.

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

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' 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

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do 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

Escopos

Nome Description
vso.work_write Concede a capacidade de ler, criar e atualizar itens de trabalho e consultas, atualizar metadados do quadro, ler área e iterações caminhos de outros metadados relacionados ao item de trabalho, 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

Solicitação de exemplo

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

{
  "isLocked": true
}

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

{
  "isDeleted": false
}

Resposta de exemplo

Código de status:
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"
}

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 são propriedades específicas para esse tipo de item de trabalho.
WorkItemFieldOperation

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

FieldType

Enumeração

O tipo do campo.

Valor Description
boolean

Tipo de campo booliano.
dateTime

Tipo de campo datetime.
double

Tipo de campo duplo.
guid

Tipo de campo guid.
history

Tipo de campo Histórico.
html

Tipo de campo HTML (multilinha).
identity

Tipo de campo de identidade.
integer

Tipo de campo inteiro.
picklistDouble

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

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

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

Tipo de campo de texto sem formatação.
string

Tipo de campo de cadeia de caracteres.
treePath

Tipo de campo treepath.

FieldUpdate

Objeto

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

Enumeração

O uso do campo.

Valor Description
none

Uso vazio.
tree

Uso do campo Treenode.
workItem

Uso do campo de item de trabalho.
workItemLink

Uso do campo de link do item de trabalho.
workItemTypeExtension

Uso da Extensão de Tipo de Item de Trabalho.
Objeto

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

Objeto

Descreve um campo em um item de trabalho e são 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 (uuid)

Se esse campo for uma lista de seleção, 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

Objeto

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.