Work Items - Delete

Služba:

Work Item Tracking

Verze rozhraní API:

7.1

Odstraní zadanou pracovní položku a odešle ji do koše, aby ji bylo možné v případě potřeby obnovit zpět. Volitelně platí, že pokud je parametr destroy nastaven na hodnotu true, zničí pracovní položku trvale. UPOZORNĚNÍ: Pokud je parametr destroy nastaven na hodnotu true, pracovní položky odstraněné tímto příkazem nebudou chodit do koše a neexistuje způsob, jak je po odstranění obnovit nebo obnovit. Tento parametr nedoporučujeme používat. Pokud ano, použijte tento parametr s extrémní opatrností.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	integer (int32)	ID pracovní položky, která se má odstranit
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.
destroy	query		boolean	Volitelný parametr, pokud je nastaven na hodnotu true, pracovní položka se trvale odstraní. Poznámka: Akce zničení je trvalá a nelze ji vrátit zpět.

Odpovědi

Name	Typ	Description
200 OK	WorkItemDelete	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.work_write	Uděluje možnost číst, vytvářet a aktualizovat pracovní položky a dotazy, metadata aktualizačního panelu, oblast čtení a iterace cesty k jiným metadatům souvisejícím se sledováním pracovních položek, spouštění dotazů a přijímání oznámení o událostech pracovních položek prostřednictvím volání služeb.

Příklady

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

204

Definice

Name	Description
ReferenceLinks	Třída představující kolekci odkazů REST.
WorkItem	Popisuje pracovní položku.
WorkItemCommentVersionRef	Představuje odkaz na konkrétní verzi komentáře k pracovní položce.
WorkItemDelete	Úplný odstraněný objekt pracovní položky Zahrnuje samotnou pracovní položku.
WorkItemRelation

ReferenceLinks

Objekt

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Jen pro čtení odkazů. Vzhledem k tomu, že odkazy odkazy jsou jen pro čtení, chceme je zveřejnit jen pro čtení.

WorkItem

Objekt

Popisuje pracovní položku.

Name	Typ	Description
_links	ReferenceLinks	Odkazy na související prostředky REST
commentVersionRef	WorkItemCommentVersionRef	Odkaz na konkrétní verzi komentáře přidaného, upraveného nebo odstraněného v této revizi
fields	object	Mapa polí a hodnot pro pracovní položku
id	integer (int32)	ID pracovní položky.
relations	WorkItemRelation[]	Vztahy pracovní položky
rev	integer (int32)	Číslo revize pracovní položky
url	string

WorkItemCommentVersionRef

Objekt

Představuje odkaz na konkrétní verzi komentáře k pracovní položce.

Name	Typ	Description
commentId	integer (int32)	ID přiřazené k komentáři.
createdInRevision	integer (int32)	[Interní] Revize pracovní položky, do které byl tento komentář původně přidán.
isDeleted	boolean	[Interní] Určuje, jestli byl komentář odstraněn.
text	string	[Interní] Text komentáře.
url	string
version	integer (int32)	Číslo verze.

WorkItemDelete

Objekt

Úplný odstraněný objekt pracovní položky Zahrnuje samotnou pracovní položku.

Name	Typ	Description
code	integer (int32)	Stavový kód HTTP pro operaci pracovní položky v dávkovém požadavku.
deletedBy	string	Uživatel, který odstranil typ pracovní položky.
deletedDate	string	Datum odstranění pracovní položky.
id	integer (int32)	ID pracovní položky
message	string	Zpráva o výjimce pro operaci pracovní položky v dávkovém požadavku
name	string	Název nebo název pracovní položky
project	string	Nadřazený projekt odstraněné pracovní položky
resource	WorkItem	Objekt pracovní položky, který byl odstraněn.
type	string	Typ pracovní položky
url	string	Adresa URL rozhraní REST API prostředku

WorkItemRelation

Objekt

Name	Typ	Description
attributes	object	Kolekce atributů propojení
rel	string	Typ relace.
url	string	Adresa URL odkazu.