Fields - Get

Service:

Work Item Tracking

API Version:

4.1

Belirli bir alanla ilgili bilgileri alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
collection	path	True	string	Team Foundation Server koleksiyonunun adı.
fieldNameOrRefName	path	True	string	Alan basit adı veya başvuru adı
instance	path	True	string	TFS sunucu adı ({server:port})
project	path		string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '4.1' olarak ayarlanmalıdır.

Yanıtlar

Name	Tür	Description
200 OK	WorkItemField	başarılı işlem

Güvenlik

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	İş öğelerini, sorguları, panoları, alan ve yineleme yollarını ve diğer iş öğesi izlemeyle ilgili meta verileri okuma yeteneği verir. Ayrıca, hizmet kancaları aracılığıyla sorgu yürütme ve iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

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

Tanımlar

Name	Description
FieldType	Alanın türü.
FieldUsage	Alanın kullanımı.
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
WorkItemField	İş öğesindeki bir alanı ve bu iş öğesi türüne özgü özellikleri açıklar.
WorkItemFieldOperation	İş öğesi alanı işlemini açıklar.

FieldType

Alanın türü.

Name	Tür	Description
boolean	string	Boole alan türü.
dateTime	string	Tarih saat alan türü.
double	string	Çift alan türü.
guid	string	Guid alan türü.
history	string	Geçmiş alan türü.
html	string	HTML (Çok Satırlı) alan türü.
identity	string	Kimlik alan türü.
integer	string	Tamsayı alan türü.
picklistDouble	string	Çift seçim listesi alan türü.
picklistInteger	string	Tamsayı seçim listesi alan türü.
picklistString	string	Dize seçim listesi alan türü.
plainText	string	Düz metin alanı türü.
string	string	Dize alan türü.
treePath	string	Ağaç yolu alan türü.

FieldUsage

Alanın kullanımı.

Name	Tür	Description
none	string	Boş kullanım.
tree	string	Ağaç düğümü alanı kullanımı.
workItem	string	İş öğesi alanı kullanımı.
workItemLink	string	İş öğesi bağlantı alanı kullanımı.
workItemTypeExtension	string	İş Öğesi Türü Uzantısı kullanımı.

ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz.

WorkItemField

İş öğesindeki bir alanı ve bu iş öğesi türüne özgü özellikleri açıklar.

Name	Tür	Description
_links	ReferenceLinks	İlgili REST kaynaklarına bağlantı başvuruları.
description	string	Alanın açıklaması.
isIdentity	boolean	Bu alanın bir kimlik alanı olup olmadığını gösterir.
isPicklist	boolean	Bu örneğin seçim listesi olup olmadığını gösterir.
isPicklistSuggested	boolean	Bu örneğin önerilen bir seçim listesi olup olmadığını gösterir.
name	string	Alanın adı.
readOnly	boolean	Alanın [salt okunur] olup olmadığını gösterir.
referenceName	string	Alanın başvuru adı.
supportedOperations	WorkItemFieldOperation[]	Bu alanda desteklenen işlemler.
type	FieldType	Alanın türü.
url	string
usage	FieldUsage	Alanın kullanımı.

WorkItemFieldOperation

İş öğesi alanı işlemini açıklar.

Name	Tür	Description
name	string	İşlemin adı.
referenceName	string	İşlemin başvuru adı.