Azure Boards Activities
Use the Azure Boards group to manage work items, comments and attachments in an Azure DevOps project from a workflow.
Every activity in this group is built on the REST Client and calls
https://dev.azure.com. The endpoint, method and query parameters are prefilled; you
supply the organization, project and the identifiers for the resource you are acting on.
Available activities
Work items
| Activity | Purpose |
|---|---|
| CreateWorkItem | Creates a work item of a given type |
| GetWorkItem | Retrieves a single work item by ID |
| GetWorkItemTemplate | Retrieves the template for a work item type |
| UpdateWorkItem | Updates a work item |
| DeleteWorkItem | Deletes a work item |
| QueryByWiql | Runs a WIQL query and returns matching work items |
Work item history
| Activity | Purpose |
|---|---|
| GetWorkItemUpdate | Retrieves one revision of a work item |
| GetWorkItemUpdates | Retrieves the revision history of a work item |
Comments
| Activity | Purpose |
|---|---|
| AddCommentToWorkItem | Adds a comment to a work item |
| GetWorkItemComment | Retrieves a single comment |
| GetWorkItemComments | Retrieves a batch of comments |
| UpdateComment | Updates a comment |
| DeleteComment | Deletes a comment |
Attachments
| Activity | Purpose |
|---|---|
| CreateAttachment | Uploads an attachment |
| UploadAttachmentChunk | Uploads one chunk of a large attachment |
| GetAttachment | Retrieves an attachment |
| DeleteAttachment | Deletes an attachment |
Common configuration
Every activity in this group shares three required fields:
| Field | Description |
|---|---|
| API Version | The version of the Azure DevOps API to use. Required on every activity. |
| Organization | The name of the Azure DevOps organization. |
| Project | The name of the project. |
api-version is a required query parameter on every endpoint in this group and ships with
no default value, so API Version must be set for the request to succeed.
Authentication
Most activities offer four Auth Type options — No Auth, Basic, API Key and OAuth 2 — with User Name and Password for Basic authentication. CreateWorkItem also offers an Auth Resource, an OAuth resource containing credentials.