Fields - Update
Mettez à jour un champ.
PATCH https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
field
|
path | True |
string |
Nom/nom de référence du champ à mettre à jour |
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
project
|
path |
string |
ID de projet ou nom du projet |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API. |
Corps de la demande
Nom | Type | Description |
---|---|---|
isDeleted |
boolean |
Indique si l’utilisateur souhaite restaurer le champ. |
isLocked |
boolean |
Indique si l’utilisateur souhaite verrouiller le champ. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
Nom | Description |
---|---|
vso.work_write | Octroie la possibilité de lire, de créer et de mettre à jour des éléments de travail et des requêtes, de mettre à jour des métadonnées de carte, de lire des zones de lecture et des itérations chemins d’accès à d’autres métadonnées associées au suivi des éléments de travail, d’exécuter des requêtes et de recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
Exemples
Set field locked |
Undelete a field |
Set field locked
Exemple de requête
PATCH https://dev.azure.com/{organization}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1
{
"isLocked": true
}
Exemple de réponse
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
Exemple de requête
PATCH https://dev.azure.com/{organization}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1
{
"isDeleted": false
}
Exemple de réponse
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"
}
Définitions
Nom | Description |
---|---|
Field |
Type du champ. |
Field |
Décrit une demande de mise à jour pour un champ d’élément de travail. |
Field |
Utilisation du champ. |
Reference |
Classe à représenter une collection de liens de référence REST. |
Work |
Décrit un champ sur un élément de travail et ses propriétés spécifiques à ce type d’élément de travail. |
Work |
Décrit une opération de champ d’élément de travail. |
FieldType
Type du champ.
Valeur | Description |
---|---|
boolean |
Type de champ booléen. |
dateTime |
Type de champ Datetime. |
double |
Type de champ double. |
guid |
Type de champ Guid. |
history |
Type de champ Historique. |
html |
Type de champ HTML (multiligne). |
identity |
Type de champ Identité. |
integer |
Type de champ Entier. |
picklistDouble |
Type de champ de liste de sélection double. Lorsque vous créez un champ de liste de sélection double à partir de l’API REST, utilisez « Double » FieldType. |
picklistInteger |
Type de champ de liste de sélection entière. Lors de la création d’un champ de liste déroulante entière à partir de l’API REST, utilisez « Integer » FieldType. |
picklistString |
Type de champ de liste de sélection de chaîne. Lorsque vous créez un champ de liste de sélection de chaîne à partir de l’API REST, utilisez « String » FieldType. |
plainText |
Type de champ de texte brut. |
string |
Type de champ de chaîne. |
treePath |
Type de champ Treepath. |
FieldUpdate
Décrit une demande de mise à jour pour un champ d’élément de travail.
Nom | Type | Description |
---|---|---|
isDeleted |
boolean |
Indique si l’utilisateur souhaite restaurer le champ. |
isLocked |
boolean |
Indique si l’utilisateur souhaite verrouiller le champ. |
FieldUsage
Utilisation du champ.
Valeur | Description |
---|---|
none |
Utilisation vide. |
tree |
Utilisation des champs Treenode. |
workItem |
Utilisation des champs d’élément de travail. |
workItemLink |
Utilisation du champ lien élément de travail. |
workItemTypeExtension |
Utilisation de l’extension de type d’élément de travail. |
ReferenceLinks
Classe à représenter une collection de liens de référence REST.
Nom | Type | Description |
---|---|---|
links |
object |
Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
WorkItemField2
Décrit un champ sur un élément de travail et ses propriétés spécifiques à ce type d’élément de travail.
Nom | Type | Description |
---|---|---|
_links |
Lier des références aux ressources REST associées. |
|
canSortBy |
boolean |
Indique si le champ est triable dans les requêtes serveur. |
description |
string |
Description du champ. |
isDeleted |
boolean |
Indique si ce champ est supprimé. |
isIdentity |
boolean |
Indique si ce champ est un champ d’identité. |
isLocked |
boolean |
Indique si ce champ est marqué comme verrouillé pour modification. |
isPicklist |
boolean |
Indique si cette instance est picklist. |
isPicklistSuggested |
boolean |
Indique si cette instance est une liste de choix suggérée. |
isQueryable |
boolean |
Indique si le champ peut être interrogé sur le serveur. |
name |
string |
Nom du champ. |
picklistId |
string (uuid) |
Si ce champ est sélectionné, l’identificateur de la liste de sélection associée, sinon null |
readOnly |
boolean |
Indique si le champ est [en lecture seule]. |
referenceName |
string |
Nom de référence du champ. |
supportedOperations |
Opérations prises en charge sur ce champ. |
|
type |
Type du champ. |
|
url |
string |
|
usage |
Utilisation du champ. |
WorkItemFieldOperation
Décrit une opération de champ d’élément de travail.
Nom | Type | Description |
---|---|---|
name |
string |
Nom convivial de l’opération. |
referenceName |
string |
Nom de référence de l’opération. |