Aracılığıyla paylaş


Fields - Get

Belirli bir alanla ilgili bilgileri alır.

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

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 sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.3' olarak ayarlanmalıdır.

Yanıtlar

Name Tür Description
200 OK

WorkItemField2

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 sorguları yürütme, iş öğelerini arama ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

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

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

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ü. REST API'den çift seçim listesi alanı oluştururken "Double" FieldType kullanın.

picklistInteger

string

Tamsayı seçim listesi alan türü. REST API'den bir tamsayı seçim listesi alanı oluştururken "Integer" FieldType kullanın.

picklistString

string

Dize seçim listesi alan türü. REST API'den dize seçim listesi alanı oluştururken "String" FieldType kullanın.

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

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.

WorkItemField2

İş öğ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ı.

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

Bu alan seçim listesi ise, ilişkili seçim listesinin tanımlayıcısı, aksi halde 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

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

Name Tür Description
name

string

İşlemin kolay adı.

referenceName

string

İşlemin başvuru adı.