Udostępnij za pośrednictwem


Fields - Get

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

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

Sample Request

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

Sample Response

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

Typ pola.

Nazwa Typ Opis
boolean

string

Typ pola logicznego.

dateTime

string

Typ pola Data/godzina.

double

string

Typ pola podwójnego.

guid

string

Typ pola identyfikatora 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. Podczas tworzenia pola podwójnej listy wyboru z interfejsu API REST użyj wartości "Double" FieldType.

picklistInteger

string

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

string

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

string

Typ pola zwykłego tekstu.

string

string

Typ pola ciąg.

treePath

string

Typ pola Ścieżka drzewa.

FieldUsage

Użycie pola.

Nazwa Typ Opis
none

string

Puste użycie.

tree

string

Użycie pola drzewa.

workItem

string

Użycie pola elementu roboczego.

workItemLink

string

Użycie pola łącza elementu roboczego.

workItemTypeExtension

string

Użycie rozszerzenia typu elementu roboczego.

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

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

Opisuje operację pola elementu roboczego.

Nazwa Typ Opis
name

string

Przyjazna nazwa operacji.

referenceName

string

Nazwa odwołania do operacji.