Sdílet prostřednictvím

Fields - Get

  • Reference
Služba:
Work Item Tracking
Verze rozhraní API:
7.1

Získá informace o konkrétním poli.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
fieldNameOrRefName
 path True

string

Jednoduchý název pole nebo název odkazu
organization
 path True

string

Název organizace Azure DevOps.
project
 path

string

ID projektu nebo název projektu
api-version
 query True

string

Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.

Odpovědi

Name Typ Description
200 OK

WorkItemField2

úspěšná operace

Zabezpečení

oauth2

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

Rozsahy

Name Description
vso.work Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím volání služby.

Příklady

Gets information on a specific field

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}

Definice

Name Description
FieldType

Typ pole.
FieldUsage

Použití pole.
ReferenceLinks

Třída představující kolekci odkazů REST.
WorkItemField2

Popisuje pole u pracovní položky a jeho vlastnosti specifické pro daný typ pracovní položky.
WorkItemFieldOperation

Popisuje operaci pole pracovní položky.

FieldType

Výčet

Typ pole.

Hodnota Description
boolean

Typ logického pole.
dateTime

Typ pole Datetime
double

Typ dvojitého pole.
guid

Typ pole Guid.
history

Typ pole Historie
html

Typ pole HTML (Víceřádkový).
identity

Typ pole identity.
integer

Typ celočíselného pole.
picklistDouble

Typ pole s dvojitým rozevíracím seznamem Při vytváření pole s dvojitým rozevíracím seznamem z rozhraní REST API použijte double FieldType.
picklistInteger

Typ pole rozevíracího seznamu typu celé číslo Při vytváření celočíselného pole rozevíracího seznamu z rozhraní REST API použijte integer FieldType.
picklistString

Typ pole rozevíracího seznamu řetězců. Při vytváření pole rozevíracího seznamu řetězců z rozhraní REST API použijte "String" FieldType.
plainText

Typ pole prostého textu.
string

Typ pole Typu řetězce.
treePath

Typ pole Cesta ke stromové struktuře.

FieldUsage

Výčet

Použití pole.

Hodnota Description
none

Prázdné využití.
tree

Použití pole Treenode
workItem

Použití pole pracovní položky
workItemLink

Využití polí odkazu na pracovní položku
workItemTypeExtension

Použití rozšíření typu pracovní položky
Objekt

Třída představující kolekci odkazů REST.

Name Typ Description
links

object

Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

WorkItemField2

Objekt

Popisuje pole u pracovní položky a jeho vlastnosti specifické pro daný typ pracovní položky.

Name Typ Description
_links

ReferenceLinks

Odkazy na související prostředky REST
canSortBy

boolean

Určuje, jestli je pole seřazené v serverových dotazech.
description

string

Popis pole.
isDeleted

boolean

Určuje, zda je toto pole odstraněno.
isIdentity

boolean

Určuje, jestli je toto pole pole identitou.
isLocked

boolean

Určuje, jestli je toto pole označené jako uzamčené pro úpravy.
isPicklist

boolean

Určuje, zda je tato instance rozevírací seznam.
isPicklistSuggested

boolean

Určuje, zda je tato instance navrhovaným rozevíracím seznamem .
isQueryable

boolean

Určuje, jestli se pole může dotazovat na serveru.
name

string

Název pole.
picklistId

string (uuid)

Pokud je toto pole rozevírací seznam, identifikátor přidruženého rozevíracího seznamu, jinak null
readOnly

boolean

Určuje, zda je pole [jen pro čtení].
referenceName

string

Název odkazu pole.
supportedOperations

WorkItemFieldOperation[]

Podporované operace v tomto poli.
type

FieldType

Typ pole.
url

string

usage

FieldUsage

Použití pole.

WorkItemFieldOperation

Objekt

Popisuje operaci pole pracovní položky.

Name Typ Description
name

string

Popisný název operace.
referenceName

string

Název odkazu operace.