Fields - Update

Referensi

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Memperbarui bidang.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
fieldNameOrRefName	path	True	string	Nama/nama referensi bidang yang akan diperbarui
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-preview.3' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
isDeleted	boolean	Menunjukkan apakah pengguna ingin memulihkan bidang.
isLocked	boolean	Menunjukkan apakah pengguna ingin mengunci bidang.

Respons

Nama	Jenis	Deskripsi
200 OK	WorkItemField2	operasi berhasil

Keamanan

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

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

Contoh

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

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

{
  "isLocked": true
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

Sample Request

HTTP

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

{
  "isDeleted": false
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Definisi

Nama	Deskripsi
FieldType	Jenis bidang .
FieldUpdate	Menjelaskan permintaan pembaruan untuk bidang item kerja.
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

Jenis bidang .

Nama	Jenis	Deskripsi
boolean	string	Jenis bidang Boolean.
dateTime	string	Jenis bidang tanggalwaktu.
double	string	Jenis bidang ganda.
guid	string	Jenis bidang guid.
history	string	Jenis bidang riwayat.
html	string	Jenis bidang HTML (Multibaris).
identity	string	Jenis bidang identitas.
integer	string	Jenis bidang bilangan bulat.
picklistDouble	string	Jenis bidang daftar pilihan ganda. Saat membuat bidang daftar pilihan ganda dari REST API, gunakan FieldType "Ganda".
picklistInteger	string	Jenis bidang daftar pilih bilangan bulat. Saat membuat bidang daftar pilih bilangan bulat dari REST API, gunakan FieldType "Bilangan Bulat".
picklistString	string	Jenis bidang daftar pilih string. Saat membuat bidang daftar pilih string dari REST API, gunakan FieldType "String".
plainText	string	Jenis bidang teks biasa.
string	string	Jenis bidang string.
treePath	string	Jenis bidang treepath.

FieldUpdate

Menjelaskan permintaan pembaruan untuk bidang item kerja.

Nama	Jenis	Deskripsi
isDeleted	boolean	Menunjukkan apakah pengguna ingin memulihkan bidang.
isLocked	boolean	Menunjukkan apakah pengguna ingin mengunci bidang.

FieldUsage

Penggunaan bidang .

Nama	Jenis	Deskripsi
none	string	Penggunaan kosong.
tree	string	Penggunaan bidang treenode.
workItem	string	Penggunaan bidang item kerja.
workItemLink	string	Penggunaan bidang tautan item kerja.
workItemTypeExtension	string	Penggunaan Ekstensi Jenis Item Kerja.

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

WorkItemField2

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 pilihan yang disarankan.
isQueryable	boolean	Menunjukkan apakah bidang dapat dikueri di server.
name	string	Nama bidang.
picklistId	string	Jika bidang ini adalah daftar pilihan, pengidentifikasi daftar pilihan 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

Menjelaskan operasi bidang item kerja.

Nama	Jenis	Deskripsi
name	string	Nama operasi yang mudah diingat.
referenceName	string	Nama referensi operasi.

Fields - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

oauth2

Scopes

Contoh

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Definisi

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Saran dan Komentar

Sumber Daya Tambahan: