Fields - Get

Dienst:

Work Item Tracking

API-Version:

7.1

Ruft Informationen zu einem bestimmten Feld ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
fieldNameOrRefName	path	True	string	Einfacher 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 "7.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemField2	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.work	Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.

Beispiele

Gets information on a specific field

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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-Referenzverknüpfungslinks darstellt.
WorkItemField2	Beschreibt ein Feld für eine Arbeitsaufgabe und für diesen Arbeitsaufgabentyp spezifische Eigenschaften.
WorkItemFieldOperation	Beschreibt einen Arbeitsaufgabenfeldvorgang.

FieldType

Enumeration

Der Typ des Felds.

Wert	Beschreibung
boolean	Boolescher Feldtyp.
dateTime	Datetime-Feldtyp.
double	Doppelter Feldtyp.
guid	Guid-Feldtyp.
history	Typ des Verlaufsfelds.
html	HTML-Feldtyp (Multiline).
identity	Identitätsfeldtyp.
integer	Ganzzahliger Feldtyp.
picklistDouble	Doppelter Auswahlfeldtyp. Verwenden Sie beim Erstellen eines Doppeltauswahlfelds aus der REST-API "Double" FieldType.
picklistInteger	Feldtyp "Ganzzahlauswahlliste". Verwenden Sie beim Erstellen eines ganzzahligen Auswahllistenfelds aus der REST-API "Integer" FieldType.
picklistString	Zeichenfolgenauswahlfeldtyp. Verwenden Sie beim Erstellen eines Zeichenfolgenauswahlfelds aus der REST-API "String" FieldType.
plainText	Nur-Text-Feldtyp.
string	Zeichenfolgenfeldtyp.
treePath	Treepath-Feldtyp.

FieldUsage

Enumeration

Die Verwendung des Felds.

Wert	Beschreibung
none	Leere Verwendung.
tree	Treenode-Feldverwendung.
workItem	Feldverwendung für Arbeitsaufgaben.
workItemLink	Feldverwendung für Arbeitsaufgabenlinks.
workItemTypeExtension	Verwendung der Arbeitsaufgabentyperweiterung.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

WorkItemField2

Objekt

Beschreibt ein Feld für eine Arbeitsaufgabe und für diesen Arbeitsaufgabentyp spezifische Eigenschaften.

Name	Typ	Beschreibung
_links	ReferenceLinks	Verknüpfen Sie Verweise auf verwandte REST-Ressourcen.
canSortBy	boolean	Gibt an, ob das Feld in Serverabfragen sortiert werden kann.
description	string	Die Beschreibung des Felds.
isDeleted	boolean	Gibt an, ob dieses Feld gelöscht wird.
isIdentity	boolean	Gibt an, ob es sich bei diesem Feld um ein Identitätsfeld handelt.
isLocked	boolean	Gibt an, ob dieses Feld zur Bearbeitung als gesperrt markiert ist.
isPicklist	boolean	Gibt an, ob diese Instanz die Auswahlliste ist.
isPicklistSuggested	boolean	Gibt an, ob es sich bei dieser Instanz 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 (uuid)	Wenn es sich bei diesem Feld um die 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 in diesem Feld.
type	FieldType	Der Typ des Felds.
url	string
usage	FieldUsage	Die Verwendung des Felds.

WorkItemFieldOperation

Objekt

Beschreibt einen Arbeitsaufgabenfeldvorgang.

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