Fields - Get

Usługa:

Work Item Tracking

Wersja interfejsu API:

7.1-preview.3

Pobiera informacje o określonym polu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
fieldNameOrRefName	path	True	string	Prosta nazwa pola lub nazwa odwołania
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.3", aby używać tej wersji interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItemField2	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 ze śledzeniem elementów roboczych. Umożliwia również wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Gets information on a specific field

Przykładowe żądanie

HTTP

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

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://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Definicje

Nazwa	Opis
FieldType	Typ pola.
FieldUsage	Użycie pola.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
WorkItemField2	Opisuje pole elementu roboczego i jego 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 pola podwójnego.
guid	Typ pola identyfikatora 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. Podczas tworzenia pola podwójnej listy wyboru z interfejsu API REST użyj wartości "Double" FieldType.
picklistInteger	Typ pola Lista wyboru liczb całkowitych. Podczas tworzenia pola listy wyboru liczb całkowitych z interfejsu API REST użyj wartości FieldType "Liczba całkowita".
picklistString	Typ pola lista wyboru ciągów. Podczas tworzenia pola listy wyboru ciągów z interfejsu API REST użyj wartości FieldType "String".
plainText	Typ pola zwykłego tekstu.
string	Typ pola ciąg.
treePath	Typ pola Ścieżka drzewa.

FieldUsage

Enumeration

Użycie pola.

Wartość	Opis
none	Puste użycie.
tree	Użycie pola 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	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItemField2

Object

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

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki do powiązanych zasobów REST.
canSortBy	boolean	Wskazuje, czy pole jest sortowalne w zapytaniach serwera.
description	string	Opis pola.
isDeleted	boolean	Wskazuje, czy to pole zostało usunięte.
isIdentity	boolean	Wskazuje, czy to pole jest polem tożsamości.
isLocked	boolean	Wskazuje, czy to pole jest oznaczone jako zablokowane do edycji.
isPicklist	boolean	Wskazuje, czy to wystąpienie jest listą wyboru.
isPicklistSuggested	boolean	Wskazuje, czy to wystąpienie jest sugerowaną listą wyboru .
isQueryable	boolean	Wskazuje, czy pole może być odpytywane na serwerze.
name	string	Nazwa pola.
picklistId	string	Jeśli to pole jest listą wyboru, identyfikator skojarzonej listy wyboru, w przeciwnym razie wartość null
readOnly	boolean	Wskazuje, czy pole jest [tylko do odczytu].
referenceName	string	Nazwa odwołania do 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	Przyjazna nazwa operacji.
referenceName	string	Nazwa odwołania do operacji.