Fields - Get

Service:

Work Item Tracking

API Version:

4.1

Ruft Informationen zu einem bestimmten Feld ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
collection	path	True	string	Der Name der Team Foundation Server-Auflistung.
fieldNameOrRefName	path	True	string	Einfacher Feldname oder Verweisname
instance	path	True	string	TFS-Servername ({server:port})
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "4.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemField	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.work	Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Ermöglicht außerdem das Ausführen von Abfragen und das Empfangen von Benachrichtigungen zu Arbeitselementereignissen über Diensthooks.

Beispiele

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

Definitionen

Name	Beschreibung
FieldType	Der Typ des Felds.
FieldUsage	Die Verwendung des Felds.
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
WorkItemField	Beschreibt ein Feld für ein Arbeitselement und dessen Eigenschaften, die für diesen Arbeitselementtyp spezifisch sind.
WorkItemFieldOperation	Beschreibt einen Arbeitselementfeldvorgang.

FieldType

Der Typ des Felds.

Name	Typ	Beschreibung
boolean	string	Boolescher Feldtyp.
dateTime	string	Datetime-Feldtyp.
double	string	Doppelter Feldtyp.
guid	string	Guid-Feldtyp.
history	string	Typ des Verlaufsfelds.
html	string	HTML-Feldtyp (Mehrzeile).
identity	string	Identitätsfeldtyp.
integer	string	Ganzzahlfeldtyp.
picklistDouble	string	Doppelter Auswahlfeldtyp.
picklistInteger	string	Ganzzahliger Auswahlfeldtyp.
picklistString	string	Zeichenfolgenauswahlfeldtyp.
plainText	string	Nur-Text-Feldtyp.
string	string	Zeichenfolgenfeldtyp.
treePath	string	Treepath-Feldtyp.

FieldUsage

Die Verwendung des Felds.

Name	Typ	Beschreibung
none	string	Leere Verwendung.
tree	string	Verwendung des Treenode-Felds.
workItem	string	Verwendung des Arbeitselementfelds.
workItemLink	string	Verwendung des Arbeitselementlinkfelds.
workItemTypeExtension	string	Verwendung der Arbeitselementtyperweiterung.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

WorkItemField

Beschreibt ein Feld für ein Arbeitselement und dessen Eigenschaften, die für diesen Arbeitselementtyp spezifisch sind.

Name	Typ	Beschreibung
_links	ReferenceLinks	Links zu verwandten REST-Ressourcen.
description	string	Die Beschreibung des Felds.
isIdentity	boolean	Gibt an, ob es sich bei diesem Feld um ein Identitätsfeld handelt.
isPicklist	boolean	Gibt an, ob es sich bei diesem instance um eine Auswahlliste handelt.
isPicklistSuggested	boolean	Gibt an, ob es sich bei diesem instance um eine vorgeschlagene Auswahlliste handelt.
name	string	Der Name des Felds.
readOnly	boolean	Gibt an, ob das Feld [schreibschutz] ist.
referenceName	string	Der Verweisname des Felds.
supportedOperations	WorkItemFieldOperation[]	Die unterstützten Vorgänge in diesem Feld.
type	FieldType	Der Typ des Felds.
url	string
usage	FieldUsage	Die Verwendung des Felds.

WorkItemFieldOperation

Beschreibt einen Arbeitselementfeldvorgang.

Name	Typ	Beschreibung
name	string	Name des Vorgangs.
referenceName	string	Verweisname des Vorgangs.