Fields - Get

Usługa:

Work Item Tracking

Wersja interfejsu API:

4.1

Pobiera informacje o określonym polu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
collection	path	True	string	Nazwa kolekcji Team Foundation Server.
fieldNameOrRefName	path	True	string	Prosta nazwa pola lub nazwa odwołania
instance	path	True	string	Nazwa serwera TFS ({server:port})
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "4.1", aby używać tej wersji interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItemField	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych elementów roboczych. Umożliwia również wykonywanie zapytań i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
FieldType	Typ pola.
FieldUsage	Użycie pola.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
WorkItemField	Opisuje pole elementu roboczego i właściwości specyficzne dla tego typu elementu roboczego.
WorkItemFieldOperation	Opisuje operację pola elementu roboczego.

FieldType

Enumeration

Typ pola.

Wartość	Opis
boolean	Typ pola logicznego.
dateTime	Typ pola Data/godzina.
double	Typ podwójnego pola.
guid	Typ pola Guid.
history	Typ pola Historia.
html	Typ pola HTML (wielowierszowy).
identity	Typ pola Tożsamość.
integer	Typ pola Liczba całkowita.
picklistDouble	Podwójny typ pola listy wyboru.
picklistInteger	Typ pola Listy wyboru liczby całkowitej.
picklistString	Typ pola listy wyboru ciągu.
plainText	Typ pola zwykłego tekstu.
string	Typ pola ciągu.
treePath	Typ pola Ścieżka drzewa.

FieldUsage

Enumeration

Użycie pola.

Wartość	Opis
none	Puste użycie.
tree	Użycie pola węzła drzewa.
workItem	Użycie pola elementu roboczego.
workItemLink	Użycie pola łącza elementu roboczego.
workItemTypeExtension	Użycie rozszerzenia typu elementu roboczego.

ReferenceLinks

Object

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItemField

Object

Opisuje pole elementu roboczego i właściwości specyficzne dla tego typu elementu roboczego.

Nazwa	Typ	Opis
_links	ReferenceLinks	Połącz odwołania do powiązanych zasobów REST.
description	string	Opis pola.
isIdentity	boolean	Wskazuje, czy to pole jest polem tożsamości.
isPicklist	boolean	Wskazuje, czy to wystąpienie jest listą wyboru.
isPicklistSuggested	boolean	Wskazuje, czy to wystąpienie jest sugerowaną listą wyboru .
name	string	Nazwa pola.
readOnly	boolean	Wskazuje, czy pole jest [tylko do odczytu].
referenceName	string	Nazwa odwołania pola.
supportedOperations	WorkItemFieldOperation[]	Obsługiwane operacje w tym polu.
type	FieldType	Typ pola.
url	string
usage	FieldUsage	Użycie pola.

WorkItemFieldOperation

Object

Opisuje operację pola elementu roboczego.

Nazwa	Typ	Opis
name	string	Nazwa operacji.
referenceName	string	Nazwa odwołania operacji.