Skip to main content

Delete Attachment

DeleteAttachment deletes an attachment.

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

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

Configuration

FieldRequiredDescription
NameOptionalName of the step, should be unique within this workflow.
DescriptionOptionalDescribe the purpose or function of this step.
Api VersionRequiredEnter the version of the API you want to use.
OrganizationOptionalEnter the name of the organization.
ProjectOptionalEnter the name of the project.
IdOptionalEnter the ID of the resource.

Auth

FieldRequiredDescription
Auth TypeOptionalSelect the authentication method for the request. Options: No Auth, Basic, API Key, OAuth 2.
User NameOptionalUsername for Basic Authentication.
PasswordOptionalPassword 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.

FieldRequiredData TypeDescription
TargetRequiredObjectThe HTTP request.

Output

The activity returns an httpResponse object.

FieldData TypeDescription
status.codeIntegerNumeric HTTP status code.
status.messageStringShort message associated with the HTTP status.
headersObjectHTTP response headers.
bodyObjectParsed body of the response.

The response body reports what the delete affected:

FieldData TypeDescription
attachmentObjectThe deleted attachment.
affectedWorkItemsArrayWork items with attachment references that have been marked as deleted.