Fields - Get

Hizmet:

Work Item Tracking

API Sürümü:

7.1

Belirli bir alanla ilgili bilgileri alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
fieldNameOrRefName	path	True	string	Alan basit adı veya başvuru adı
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje kimliği veya proje adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

Yanıtlar

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

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Name	Description
vso.work	İş öğelerini, sorguları, panoları, alan ve yineleme yollarını ve diğer iş öğesi izlemeyle ilgili meta verileri okuma olanağı verir. Ayrıca, hizmet kancaları aracılığıyla sorgu yürütme, iş öğelerinde arama yapma ve iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

Gets information on a specific field

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

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

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.
WorkItemField2	İş öğesindeki bir alanı ve bu iş öğesi türüne özgü özellikleri açıklar.
WorkItemFieldOperation	İş öğesi alanı işlemini açıklar.

FieldType

Listeleme

Alanın türü.

Değer	Description
boolean	Boole alan türü.
dateTime	Tarih saat alan türü.
double	Çift alan türü.
guid	Guid alan türü.
history	Geçmiş alan türü.
html	HTML (Çok Satırlı) alan türü.
identity	Kimlik alan türü.
integer	Tamsayı alan türü.
picklistDouble	Çift seçim listesi alan türü. REST API'den bir çift seçim listesi alanı oluştururken "Double" FieldType kullanın.
picklistInteger	Tamsayı seçim listesi alan türü. REST API'den bir tamsayı seçim listesi alanı oluştururken "Integer" FieldType kullanın.
picklistString	Dize seçim listesi alan türü. REST API'den dize seçim listesi alanı oluştururken "String" FieldType kullanın.
plainText	Düz metin alanı türü.
string	Dize alan türü.
treePath	Ağaç yolu alan türü.

FieldUsage

Listeleme

Alanın kullanımı.

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

ReferenceLinks

Object

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 kullanıma açmak istiyoruz.

WorkItemField2

Object

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

Name	Tür	Description
_links	ReferenceLinks	Başvuruları ilgili REST kaynaklarına bağlayın.
canSortBy	boolean	Alanın sunucu sorgularında sıralanabilir olup olmadığını gösterir.
description	string	Alanın açıklaması.
isDeleted	boolean	Bu alanın silinip silinmediğini gösterir.
isIdentity	boolean	Bu alanın bir kimlik alanı olup olmadığını gösterir.
isLocked	boolean	Bu alanın düzenleme için kilitli olarak işaretlenip işaretlenmediğini 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.
isQueryable	boolean	Alanın sunucuda sorgulanıp sorgulanamayacağını gösterir.
name	string	Alanın adı.
picklistId	string (uuid)	Bu alan seçim listesi ise, seçim listesinin tanımlayıcısı ilişkilendirilmiş, aksi takdirde null
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

Object

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

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