Bagikan melalui

Fields - Get

  • Referensi
Layanan:
Work Item Tracking
Versi API:
7.1

Mendapatkan informasi tentang bidang tertentu.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
fieldNameOrRefName
 path True

string

Nama sederhana bidang atau nama referensi
organization
 path True

string

Nama organisasi Azure DevOps.
project
 path

string

ID proyek atau nama proyek
api-version
 query True

string

Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.

Respons

Nama Jenis Deskripsi
200 OK

WorkItemField2

operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Cakupan

Nama Deskripsi
vso.work Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur area dan iterasi, dan metadata terkait pelacakan item kerja lainnya. Juga memberikan kemampuan untuk menjalankan kueri, mencari item kerja, dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Gets information on a specific field

Permintaan sampel

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

Respon sampel

Kode status:
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"
}

Definisi

Nama Deskripsi
FieldType

Jenis bidang .
FieldUsage

Penggunaan bidang .
ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.
WorkItemField2

Menjelaskan bidang pada item kerja dan properti khusus untuk jenis item kerja tersebut.
WorkItemFieldOperation

Menjelaskan operasi bidang item kerja.

FieldType

Enumeration

Jenis bidang .

Nilai Deskripsi
boolean

Jenis bidang Boolean.
dateTime

Jenis bidang tanggalwaktu.
double

Jenis bidang ganda.
guid

Jenis bidang guid.
history

Jenis bidang riwayat.
html

Jenis bidang HTML (Multibaris).
identity

Jenis bidang identitas.
integer

Jenis bidang bilangan bulat.
picklistDouble

Jenis bidang daftar pilih ganda. Saat membuat bidang daftar pilih ganda dari REST API, gunakan FieldType "Double".
picklistInteger

Jenis bidang daftar pilih bilangan bulat. Saat membuat bidang daftar pilih bilangan bulat dari REST API, gunakan FieldType "Bilangan Bulat".
picklistString

Jenis bidang daftar pilih string. Saat membuat bidang daftar pilih string dari REST API, gunakan FieldType "String".
plainText

Jenis bidang teks biasa.
string

Jenis bidang string.
treePath

Jenis bidang Treepath.

FieldUsage

Enumeration

Penggunaan bidang .

Nilai Deskripsi
none

Penggunaan kosong.
tree

Penggunaan bidang Treenode.
workItem

Penggunaan bidang item kerja.
workItemLink

Penggunaan bidang tautan item kerja.
workItemTypeExtension

Penggunaan Ekstensi Tipe Item Kerja.
Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama Jenis Deskripsi
links

object

Tampilan tautan secara baca-saja. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

WorkItemField2

Objek

Menjelaskan bidang pada item kerja dan properti khusus untuk jenis item kerja tersebut.

Nama Jenis Deskripsi
_links

ReferenceLinks

Menautkan referensi ke sumber daya REST terkait.
canSortBy

boolean

Menunjukkan apakah bidang dapat diurutkan dalam kueri server.
description

string

Deskripsi bidang .
isDeleted

boolean

Menunjukkan apakah bidang ini dihapus.
isIdentity

boolean

Menunjukkan apakah bidang ini adalah bidang identitas.
isLocked

boolean

Menunjukkan apakah bidang ini ditandai sebagai terkunci untuk pengeditan.
isPicklist

boolean

Menunjukkan apakah instans ini adalah daftar pilihan.
isPicklistSuggested

boolean

Menunjukkan apakah instans ini adalah daftar pilih yang disarankan .
isQueryable

boolean

Menunjukkan apakah bidang dapat dikueri di server.
name

string

Nama bidang.
picklistId

string (uuid)

Jika bidang ini adalah daftar pilih, pengidentifikasi daftar pilih yang terkait, jika tidak, null
readOnly

boolean

Menunjukkan apakah bidang tersebut [baca saja].
referenceName

string

Nama referensi bidang.
supportedOperations

WorkItemFieldOperation[]

Operasi yang didukung pada bidang ini.
type

FieldType

Jenis bidang .
url

string

usage

FieldUsage

Penggunaan bidang .

WorkItemFieldOperation

Objek

Menjelaskan operasi bidang item kerja.

Nama Jenis Deskripsi
name

string

Nama operasi yang mudah diingat.
referenceName

string

Nama referensi operasi.