Get Attachment
GetAttachment retrieves an attachment by its ID.
It calls GET 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
| 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. |
| File Name | Optional | Enter the name of the file to be processed. |
| Download | Optional | Specify whether to download the file (true/false). |
Download is a checkbox. File Name and Download are query parameters.
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 — the attachment content. |
note
The output schema for this activity describes the response body only as a JSON Schema document, so no response fields are listed here.