Fields - Get

Référence

Service:: Work Item Tracking

API Version:: 4.1

Obtient des informations sur un champ spécifique.

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
collection	path	True	string	Nom de la collection Team Foundation Server.
fieldNameOrRefName	path	True	string	Nom simple du champ ou nom de référence
instance	path	True	string	Nom du serveur TFS ({server:port})
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 « 4.1 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	WorkItemField	opération réussie

Sécurité

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

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 et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Sample Request

HTTP

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Sample Response

Status code:: 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://fabrikam:8080/tfs/_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.
WorkItemField	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

Type du champ.

Nom	Type	Description
boolean	string	Type de champ booléen.
dateTime	string	Type de champ Datetime.
double	string	Type de champ double.
guid	string	Type de champ GUID.
history	string	Type de champ d’historique.
html	string	Type de champ HTML (multiligne).
identity	string	Type de champ d’identité.
integer	string	Type de champ Integer.
picklistDouble	string	Type de champ de liste de sélection double.
picklistInteger	string	Type de champ de liste de sélection entière.
picklistString	string	Type de champ de liste de sélection de chaînes.
plainText	string	Type de champ de texte brut.
string	string	Type de champ de chaîne.
treePath	string	Type de champ Treepath.

FieldUsage

Utilisation du champ.

Nom	Type	Description
none	string	Utilisation vide.
tree	string	Utilisation des champs Treenode.
workItem	string	Utilisation des champs d’élément de travail.
workItemLink	string	Utilisation du champ de lien d’élément de travail.
workItemTypeExtension	string	Utilisation de l’extension de type élément de travail.

ReferenceLinks

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.

WorkItemField

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.
description	string	Description du champ.
isIdentity	boolean	Indique si ce champ est un champ d’identité.
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.
name	string	Nom du champ.
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

Décrit une opération de champ d’élément de travail.

Nom	Type	Description
name	string	Nom de l’opération.
referenceName	string	Nom de référence de l’opération.

Share via