Udostępnij za pośrednictwem


Work Items - Delete

Usuwa określony element roboczy i wysyła go do Kosza, aby można go było przywrócić, jeśli jest to wymagane. Opcjonalnie, jeśli parametr destroy został ustawiony na wartość true, spowoduje trwałe zniszczenie elementu roboczego.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
path True

integer

int32

Identyfikator elementu roboczego do usunięcia

organization
path True

string

Nazwa organizacji usługi Azure DevOps.

project
path

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "5.0", aby używać tej wersji interfejsu API.

destroy
query

boolean

Opcjonalny parametr, jeśli jest ustawiony na wartość true, element roboczy zostanie trwale usunięty

Odpowiedzi

Nazwa Typ Opis
200 OK

WorkItemDelete

operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa Opis
vso.work_write Umożliwia odczytywanie, tworzenie i aktualizowanie elementów roboczych i zapytań, aktualizowanie metadanych tablicy, ścieżki obszaru odczytu i iteracji innych metadanych powiązanych z elementami roboczymi, wykonywanie zapytań i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Sample Request

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

Sample Response

Definicje

Nazwa Opis
ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

WorkItem

Opisuje element roboczy.

WorkItemDelete

Pełny usunięty obiekt elementu roboczego. Zawiera sam element roboczy.

WorkItemRelation

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa Typ Opis
links

object

Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItem

Opisuje element roboczy.

Nazwa Typ Opis
_links

ReferenceLinks

Linki do powiązanych zasobów REST.

fields

object

Mapa pól i wartości elementu roboczego.

id

integer

Identyfikator elementu roboczego.

relations

WorkItemRelation[]

Relacje elementu roboczego.

rev

integer

Numer poprawki elementu roboczego.

url

string

WorkItemDelete

Pełny usunięty obiekt elementu roboczego. Zawiera sam element roboczy.

Nazwa Typ Opis
code

integer

Kod stanu HTTP operacji elementu roboczego w żądaniu wsadowym.

deletedBy

string

Użytkownik, który usunął typ elementu roboczego.

deletedDate

string

Data usunięcia elementu roboczego.

id

integer

Identyfikator elementu roboczego.

message

string

Komunikat o wyjątku operacji elementu roboczego w żądaniu wsadowym.

name

string

Nazwa lub tytuł elementu roboczego.

project

string

Nadrzędny projekt usuniętego elementu roboczego.

resource

WorkItem

Usunięty obiekt elementu roboczego.

type

string

Typ elementu roboczego.

url

string

Adres URL interfejsu API REST zasobu

WorkItemRelation

Nazwa Typ Opis
attributes

object

Kolekcja atrybutów łącza.

rel

string

Typ relacji.

url

string

Adres URL łącza.