Delete Comment

DeleteComment deletes a comment from a work item.

It calls DELETE https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}, where {workItemId} and {commentId} come from the Work Item Id and Comment Id fields.

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 you want to use.
Organization	Optional	Enter the name of the organization.
Project	Optional	Enter the name of the project.
Work Item Id	Optional	Enter the ID of the work item.
Comment Id	Optional	Enter the ID of the comment.

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.

note

The output schema for this activity describes the response body only as a JSON Schema document, so no response fields are listed here.