Work Items - Delete

Service:

Work Item Tracking

API Version:

7.1-preview.3

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, pracovní položku se trvale zničí. UPOZORNĚNÍ: Pokud je parametr destroy nastavený na hodnotu true, pracovní položky odstraněné tímto příkazem NEPŘEJDOU do koše a po odstranění neexistuje žádný způsob, jak je obnovit nebo obnovit. Doporučuje se nepoužívat tento parametr. Pokud ano, používejte tento parametr velmi opatrně.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	integer int32	ID pracovní položky, která má být odstraněna
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. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.
destroy	query		boolean	Volitelný parametr, pokud je nastavená hodnota true, pracovní položka se trvale odstraní. Poznámka: Akce zničení je TRVALE a nelze ji vrátit zpět.

Odpovědi

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

Zabezpečení

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

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

Příklady

Sample Request

HTTP

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

Sample Response

Status code:

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

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

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

WorkItem

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	ID pracovní položky.
relations	WorkItemRelation[]	Vztahy pracovní položky.
rev	integer	Číslo revize pracovní položky.
url	string

WorkItemCommentVersionRef

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

Name	Typ	Description
commentId	integer	ID přiřazené ke komentáři.
createdInRevision	integer	[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	Číslo verze.

WorkItemDelete

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

Name	Typ	Description
code	integer	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	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

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