Fields - Update

Riferimento

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Aggiornare un campo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
fieldNameOrRefName	path	True	string	Nome/nome del campo da aggiornare
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path		string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.3' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
isDeleted	boolean	Indica se l'utente desidera ripristinare il campo.
isLocked	boolean	Indica se l'utente vuole bloccare il campo.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkItemField2	operazione riuscita

Sicurezza

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	Descrizione
vso.work_write	Concede la possibilità di leggere, creare e aggiornare elementi di lavoro e query, aggiornare i metadati della scheda, l'area di lettura e le iterazioni dei percorsi di altri metadati correlati al rilevamento degli elementi di lavoro, eseguire query e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

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

{
  "isLocked": true
}

Sample Response

Status code:: 200

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

Response Body

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

HTTP

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

{
  "isDeleted": false
}

Sample Response

Status code:: 200

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

Response Body

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

Definizioni

Nome	Descrizione
FieldType	Tipo del campo.
FieldUpdate	Descrive una richiesta di aggiornamento per un campo dell'elemento di lavoro.
FieldUsage	Utilizzo del campo.
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
WorkItemField2	Descrive un campo in un elemento di lavoro e le relative proprietà sono specifiche del tipo di elemento di lavoro.
WorkItemFieldOperation	Descrive un'operazione sul campo dell'elemento di lavoro.

FieldType

Tipo del campo.

Nome	Tipo	Descrizione
boolean	string	Tipo di campo booleano.
dateTime	string	Tipo di campo Datetime.
double	string	Tipo di campo Double.
guid	string	Tipo di campo GUID.
history	string	Tipo di campo Cronologia.
html	string	Tipo di campo HTML (multilinea).
identity	string	Tipo di campo Identity.
integer	string	Tipo di campo Integer.
picklistDouble	string	Tipo di campo elenco a discesa doppio. Quando si crea un campo a selezione doppia dall'API REST, usare "Double" FieldType.
picklistInteger	string	Tipo di campo elenco a discesa integer. Quando si crea un campo elenco a discesa integer dall'API REST, usare FieldType "Integer".
picklistString	string	Tipo di campo elenco a discesa stringa. Quando si crea un campo elenco a discesa di stringhe dall'API REST, usare "String" FieldType.
plainText	string	Tipo di campo testo normale.
string	string	Tipo di campo Stringa.
treePath	string	Tipo di campo Treepath.

FieldUpdate

Descrive una richiesta di aggiornamento per un campo dell'elemento di lavoro.

Nome	Tipo	Descrizione
isDeleted	boolean	Indica se l'utente desidera ripristinare il campo.
isLocked	boolean	Indica se l'utente vuole bloccare il campo.

FieldUsage

Utilizzo del campo.

Nome	Tipo	Descrizione
none	string	Utilizzo vuoto.
tree	string	Utilizzo dei campi treenode.
workItem	string	Utilizzo del campo dell'elemento di lavoro.
workItemLink	string	Utilizzo del campo di collegamento dell'elemento di lavoro.
workItemTypeExtension	string	Utilizzo dell'estensione del tipo di elemento di lavoro.

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

WorkItemField2

Descrive un campo in un elemento di lavoro e le relative proprietà sono specifiche del tipo di elemento di lavoro.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegare i riferimenti alle risorse REST correlate.
canSortBy	boolean	Indica se il campo è ordinabile nelle query del server.
description	string	Descrizione del campo.
isDeleted	boolean	Indica se questo campo viene eliminato.
isIdentity	boolean	Indica se questo campo è un campo Identity.
isLocked	boolean	Indica se questo campo è contrassegnato come bloccato per la modifica.
isPicklist	boolean	Indica se questa istanza è a discesa.
isPicklistSuggested	boolean	Indica se questa istanza è un elenco a discesa suggerito.
isQueryable	boolean	Indica se il campo può essere sottoposto a query nel server.
name	string	Nome del campo.
picklistId	string	Se questo campo è elenco a discesa, l'identificatore dell'elenco a discesa associato; in caso contrario, null
readOnly	boolean	Indica se il campo è [di sola lettura].
referenceName	string	Nome di riferimento del campo.
supportedOperations	WorkItemFieldOperation[]	Operazioni supportate in questo campo.
type	FieldType	Tipo del campo.
url	string
usage	FieldUsage	Utilizzo del campo.

WorkItemFieldOperation

Descrive un'operazione sul campo dell'elemento di lavoro.

Nome	Tipo	Descrizione
name	string	Nome descrittivo dell'operazione.
referenceName	string	Nome di riferimento dell'operazione.

Fields - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Scopes

Esempio

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Definizioni

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Commenti e suggerimenti

Risorse aggiuntive