Skip to main content

Upload Attachment Chunk

UploadAttachmentChunk uploads one chunk of an attachment, for files sent in parts rather than in a single request.

It calls PUT 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 to use.
OrganizationRequiredEnter the organization identifier.
ProjectRequiredEnter the project identifier.
IdRequiredEnter the ID of the resource.
Content Range HeaderRequiredEnter the content range header value for the request.
File NameOptionalEnter the name of the file to be processed.

Content Range Header is required and identifies which byte range of the file this chunk carries. File Name is a query parameter.

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.

The chunk content goes in the request body.

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 attachment reference.

The response body carries the attachment reference:

FieldData TypeDescription
idStringThe attachment identifier.
urlStringREST URL for the attachment.