Fields - Get

Reference

Service:: Work Item Tracking

API Version:: 4.1

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

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
collection	path	True	string	Název kolekce Team Foundation Server.
fieldNameOrRefName	path	True	string	Jednoduchý název pole nebo název odkazu
instance	path	True	string	Název serveru TFS ({server:port})
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na hodnotu 4.1.

Odpovědi

Name	Typ	Description
200 OK	WorkItemField	úspěšná operace

Zabezpečení

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

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 a přijímat oznámení o událostech pracovních položek prostřednictvím služeb.

Příklady

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

Definice

Name	Description
FieldType	Typ pole.
FieldUsage	Použití pole.
ReferenceLinks	Třída představující kolekci odkazů REST.
WorkItemField	Popisuje pole pracovní položky a jeho vlastnosti specifické pro daný typ pracovní položky.
WorkItemFieldOperation	Popisuje operaci pole pracovní položky.

FieldType

Typ pole.

Name	Typ	Description
boolean	string	Typ logického pole.
dateTime	string	Typ pole Datetime
double	string	Typ dvojitého pole.
guid	string	Typ pole Guid.
history	string	Typ pole Historie.
html	string	Typ pole HTML (Víceřádkový).
identity	string	Typ pole Identita.
integer	string	Typ pole Celé číslo.
picklistDouble	string	Typ pole dvojitého rozevíracího seznamu
picklistInteger	string	Typ pole rozevíracího seznamu celé číslo.
picklistString	string	Typ pole rozevíracího seznamu řetězců
plainText	string	Typ pole prostého textu
string	string	Typ pole Řetězec.
treePath	string	Typ pole Cesta stromové struktury.

FieldUsage

Použití pole.

Name	Typ	Description
none	string	Prázdné využití.
tree	string	Využití pole treenode.
workItem	string	Využití pole pracovní položky.
workItemLink	string	Použití pole propojení pracovní položky
workItemTypeExtension	string	Použití rozšíření typu pracovní položky

ReferenceLinks

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

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

WorkItemField

Popisuje pole 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
description	string	Popis pole
isIdentity	boolean	Označuje, zda je toto pole polem identity.
isPicklist	boolean	Určuje, zda je tato instance rozevíracím seznamem.
isPicklistSuggested	boolean	Určuje, jestli je tato instance navrhovaným rozevíracím seznamem .
name	string	Název pole.
readOnly	boolean	Určuje, jestli je pole [jen pro čtení].
referenceName	string	Referenční název pole.
supportedOperations	WorkItemFieldOperation[]	Podporované operace v tomto poli.
type	FieldType	Typ pole.
url	string
usage	FieldUsage	Použití pole.

WorkItemFieldOperation

Popisuje operaci pole pracovní položky.

Name	Typ	Description
name	string	Název operace.
referenceName	string	Referenční název operace.

Sdílet prostřednictvím