Work Items - Delete

  • Referensi
Layanan:
Work Item Tracking
Versi API:
7.1

Menghapus item kerja yang ditentukan dan mengirimkannya ke Keranjang Sampah, sehingga dapat dipulihkan kembali, jika diperlukan. Secara opsional, jika parameter penghancurkan telah diatur ke true, parameter tersebut akan menghancurkan item kerja secara permanen. PERINGATAN: Jika parameter penghancuran diatur ke true, item kerja yang dihapus oleh perintah ini TIDAK akan masuk ke keranjang sampah dan tidak ada cara untuk memulihkan/memulihkannya setelah penghapusan. Disarankan UNTUK TIDAK menggunakan parameter ini. Jika anda melakukannya, silakan gunakan parameter ini dengan sangat hati-hati.

DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1
Dengan parameter opsional: 
DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?destroy={destroy}&api-version=7.1

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
id
 path True

integer (int32)

ID item kerja yang akan dihapus
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.
destroy
 query

boolean

Parameter opsional, jika diatur ke true, item kerja akan dihapus secara permanen. Harap dicatat: tindakan perusakan bersifat PERMANEN dan tidak dapat dibatalkan.

Respons

Nama Jenis Deskripsi
200 OK

WorkItemDelete

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_write Memberikan kemampuan untuk membaca, membuat, dan memperbarui item dan kueri kerja, memperbarui metadata papan, area baca dan jalur perulangan item kerja lainnya yang melacak metadata terkait, menjalankan kueri, dan untuk menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Permintaan sampel

DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/{id}?api-version=7.1

Respon sampel

Kode status:
204

Definisi

Nama Deskripsi
ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.
WorkItem

Menjelaskan item kerja.
WorkItemCommentVersionRef

Mewakili referensi ke versi komentar tertentu pada Item Kerja.
WorkItemDelete

Objek item kerja yang dihapus penuh. Menyertakan item kerja itu sendiri.
WorkItemRelation
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.

WorkItem

Objek

Menjelaskan item kerja.

Nama Jenis Deskripsi
_links

ReferenceLinks

Menautkan referensi ke sumber daya REST terkait.
commentVersionRef

WorkItemCommentVersionRef

Referensi ke versi tertentu dari komentar yang ditambahkan/diedit/dihapus dalam revisi ini.
fields

object

Peta bidang dan nilai untuk item kerja.
id

integer (int32)

ID item kerja.
relations

WorkItemRelation[]

Hubungan item kerja.
rev

integer (int32)

Nomor revisi item kerja.
url

string

WorkItemCommentVersionRef

Objek

Mewakili referensi ke versi komentar tertentu pada Item Kerja.

Nama Jenis Deskripsi
commentId

integer (int32)

Id yang ditetapkan untuk komentar.
createdInRevision

integer (int32)

[Internal] Revisi item kerja tempat komentar ini awalnya ditambahkan.
isDeleted

boolean

[Internal] Menentukan apakah komentar telah dihapus.
text

string

[Internal] Teks komentar.
url

string

version

integer (int32)

Nomor versi.

WorkItemDelete

Objek

Objek item kerja yang dihapus penuh. Menyertakan item kerja itu sendiri.

Nama Jenis Deskripsi
code

integer (int32)

Kode status HTTP untuk operasi item kerja dalam permintaan batch.
deletedBy

string

Pengguna yang menghapus jenis item kerja.
deletedDate

string

Tanggal penghapusan item kerja.
id

integer (int32)

ID item kerja.
message

string

Pesan pengecualian untuk operasi item kerja dalam permintaan batch.
name

string

Nama atau judul item kerja.
project

string

Proyek induk item kerja yang dihapus.
resource

WorkItem

Objek item kerja yang dihapus.
type

string

Jenis item kerja.
url

string

URL REST API sumber daya

WorkItemRelation

Objek
Nama Jenis Deskripsi
attributes

object

Kumpulan atribut tautan.
rel

string

Jenis relasi.
url

string

Url tautan.