Fields - Get

Service:

Work Item Tracking

Version d'API:

7.1-preview.3

Obtient des informations sur un champ spécifique.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
fieldNameOrRefName	path	True	string	Nom simple du champ ou nom de référence
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-preview.3 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	WorkItemField2	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	Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Gets information on a specific field

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Définitions

Nom	Description
FieldType	Type du champ.
FieldUsage	Utilisation du champ.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
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.
WorkItemFieldOperation	Décrit une opération de champ d’élément de travail.

FieldType

Enumeration

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 d’historique.
html	Type de champ HTML (multiligne).
identity	Type de champ d’identité.
integer	Type de champ Integer.
picklistDouble	Type de champ de liste de sélection double. Lors de la création d’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 de choix d’entiers à partir de l’API REST, utilisez FieldType « Integer ».
picklistString	Type de champ de liste de sélection de chaînes. Lors de la création d’un champ de liste de choix de chaînes à partir de l’API REST, utilisez FieldType « String ».
plainText	Type de champ de texte brut.
string	Type de champ de chaîne.
treePath	Type de champ Treepath.

FieldUsage

Enumeration

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 de lien d’élément de travail.
workItemTypeExtension	Utilisation de l’extension de type élément de travail.

ReferenceLinks

Object

Classe pour 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

Object

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	ReferenceLinks	Lier des références à des ressources REST associées.
canSortBy	boolean	Indique si le champ peut être trié dans les requêtes de 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 une liste de sélection.
isPicklistSuggested	boolean	Indique si cette instance est une liste de choix suggérée.
isQueryable	boolean	Indique si le champ peut être interrogé dans le serveur.
name	string	Nom du champ.
picklistId	string	Si ce champ est une liste de sélection, l’identificateur de la liste de sélection est associé, sinon null
readOnly	boolean	Indique si le champ est [lecture seule].
referenceName	string	Nom de référence du champ.
supportedOperations	WorkItemFieldOperation[]	Opérations prises en charge sur ce champ.
type	FieldType	Type du champ.
url	string
usage	FieldUsage	Utilisation du champ.

WorkItemFieldOperation

Object

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.