Fields - Get

Odwołanie

Service:: Work Item Tracking

API Version:: 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

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

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

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

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

Typ pola.

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

FieldUsage

Użycie pola.

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

ReferenceLinks

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

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

Opisuje operację pola elementu roboczego.

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

Share via