Fields - Get

Referenz

Service:: Work Item Tracking

API Version:: 5.0

Ruft Informationen zu einem bestimmten Feld ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
fieldNameOrRefName	path	True	string	Feldname oder Verweisname
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "5.0" 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. Außerdem können Sie Abfragen ausführen, Arbeitselemente durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthaken empfangen.

Beispiele

Sample Request

HTTP

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

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://dev.azure.com/fabrikam/_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	Verlaufsfeldtyp.
html	string	HTML-Feldtyp (Mehrlinien).
identity	string	Identitätsfeldtyp.
integer	string	Ganzzahliger Feldtyp.
picklistDouble	string	Feldtyp mit doppelter Auswahlliste.
picklistInteger	string	Ganzzahliger Auswahllistenfeldtyp.
picklistString	string	Feldtyp der Zeichenfolgenauswahlliste.
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	Treenode-Feldnutzung.
workItem	string	Arbeitselementfeldnutzung.
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ützt sind, möchten wir sie nur als schreibgeschützt 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	Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.
canSortBy	boolean	Gibt an, ob das Feld in Serverabfragen sortierbar ist.
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.
isQueryable	boolean	Gibt an, ob das Feld auf dem Server abgefragt werden kann.
name	string	Der Name des Felds.
picklistId	string	Wenn es sich bei diesem Feld um eine Auswahlliste handelt, ist der Bezeichner der zugeordneten Auswahlliste, andernfalls NULL
readOnly	boolean	Gibt an, ob das Feld [schreibgeschützt] ist.
referenceName	string	Der Verweisname des Felds.
supportedOperations	WorkItemFieldOperation[]	Die unterstützten Vorgänge für dieses 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.

Freigeben über