Work Items - Delete Work Items

Referensi

Service:: Work Item Tracking

API Version:: 7.1-preview.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.

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsdelete?api-version=7.1-preview.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
destroy	boolean	Parameter opsional, jika diatur ke true, item kerja dihapus secara permanen. Harap dicatat: tindakan penghancurkan bersifat PERMANEN dan tidak dapat dibatalkan.
ids	integer[]	Id item kerja yang diminta
skipNotifications	boolean	Parameter opsional, jika diatur ke true, pemberitahuan akan dinonaktifkan.

Respons

Nama	Jenis	Deskripsi
200 OK	WorkItemDeleteBatch	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 perulangan item kerja lainnya yang melacak metadata terkait, menjalankan kueri, dan untuk menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/wit/workitemsdelete?api-version=7.1-preview.1

{
  "ids": [
    28,
    29
  ],
  "destroy": true,
  "skipNotifications": true
}

Sample Response

Status code:: 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.
WorkItemDeleteBatch	Menjelaskan respons untuk menghapus sekumpulan item kerja.
WorkItemDeleteBatchRequest	Menjelaskan permintaan untuk menghapus sekumpulan item kerja
WorkItemRelation

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

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

WorkItem

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	ID item kerja.
relations	WorkItemRelation[]	Hubungan item kerja.
rev	integer	Nomor revisi item kerja.
url	string

WorkItemCommentVersionRef

Mewakili referensi ke versi komentar tertentu pada Item Kerja.

Nama	Jenis	Deskripsi
commentId	integer	Id yang ditetapkan untuk komentar.
createdInRevision	integer	[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	nomor versi.

WorkItemDelete

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

Nama	Jenis	Deskripsi
code	integer	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	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 dari item kerja yang dihapus.
resource	WorkItem	Objek item kerja yang dihapus.
type	string	Jenis item kerja.
url	string	URL REST API sumber daya

WorkItemDeleteBatch

Menjelaskan respons untuk menghapus sekumpulan item kerja.

Nama	Jenis	Deskripsi
results	WorkItemDelete[]	Daftar hasil untuk setiap item kerja

WorkItemDeleteBatchRequest

Menjelaskan permintaan untuk menghapus sekumpulan item kerja

Nama	Jenis	Deskripsi
destroy	boolean	Parameter opsional, jika diatur ke true, item kerja dihapus secara permanen. Harap dicatat: tindakan penghancurkan bersifat PERMANEN dan tidak dapat dibatalkan.
ids	integer[]	Id item kerja yang diminta
skipNotifications	boolean	Parameter opsional, jika diatur ke true, pemberitahuan akan dinonaktifkan.

WorkItemRelation

Nama	Jenis	Deskripsi
attributes	object	Kumpulan atribut tautan.
rel	string	Jenis relasi.
url	string	Url tautan.

Bagikan melalui