Delete Work Item

DeleteWorkItem deletes a work item.

It calls DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}, where {id} is the value of the Id field.

The activity has four tabs: Configuration, Auth, Input, and Output.

Configuration

Field	Required	Description
Name	Optional	Name of the step, should be unique within this workflow.
Description	Optional	Describe the purpose or function of this step.
Api Version	Required	Enter the version of the API to use.
Organization	Required	Enter the name of the organization.
Project	Required	Enter the name of the project.
Id	Required	Enter the ID of the resource.
Destroy	Optional	Indicates whether to destroy the resource (true or false).

Destroy is a checkbox, and it is a query parameter on the request.

Auth

Field	Required	Description
Auth Type	Optional	Select the authentication method for the request. Options: No Auth, Basic, API Key, OAuth 2.
User Name	Optional	Username for Basic Authentication.
Password	Optional	Password for Basic Authentication.

Input

This activity is built on the REST Client, so the Input tab is the generic HTTP request rather than an Azure Boards-shaped payload.

Field	Required	Data Type	Description
Target	Required	Object	The HTTP request.

Output

The activity returns an httpResponse object.

Field	Data Type	Description
status.code	Integer	Numeric HTTP status code.
status.message	String	Short message associated with the HTTP status.
headers	Object	HTTP response headers.
body	Object	Parsed body of the response.

Field	Data Type	Description
resource	Object	Describes a work item.