ADO Boards
Azure DevOps Boards provides services for teams to track work - for any language, all in a single package.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get a User Profile |
Gets a user profile. |
| Get query results (Preview) |
Retrieves the result of a work item query. |
| Get Subjects based on query |
Get Subjects based on query |
| List Organizations |
Retrieves the list of Organizations the user is a member of. |
| List projects |
Retrieves the list of projects in an Organization. |
| List queries within folder |
Retrieves the list of work item queries within a folder for a given project. |
| List root level queries |
Retrieves the list of root-level work item queries in a project. |
| List work item types |
Retrieves the list of Work Item Types accessible in a given Azure DevOps project. |
| List work items |
Returns a list of work items. |
| Update a work item |
Update an existing work item by id. |
Get a User Profile
Gets a user profile.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Profile Id
|
id | True | string |
The ID of the profile within the same organization, or 'me' to get the profile of the current authenticated user. |
Returns
Profile
- Body
- Profile
Get query results (Preview)
Retrieves the result of a work item query.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
|
Query Id
|
queryId | True | string |
The Id of the stored query to run. |
Returns
A list of VSTS models.
- Body
- VstsListJObject
Get Subjects based on query
Get Subjects based on query
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
SearchTerm
|
query | True | string |
Search term to search for Azure Devops users or/and groups. |
|
SubjectKind
|
subjectKind | True | array of string |
User or Group can be specified, both or either |
|
Scope Descriptor
|
scopeDescriptor | string |
Optional Param |
Returns
A list of Graph Subjects.
- Body
- VstsListSubject
List Organizations
Retrieves the list of Organizations the user is a member of.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Member Id
|
memberId | True | string |
Member Id |
Returns
A list of VSTS models.
- Body
- VstsListAccount
List projects
Retrieves the list of projects in an Organization.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
Returns
A list of VSTS models.
- Body
- VstsListProject
List queries within folder
Retrieves the list of work item queries within a folder for a given project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
|
Folder Path
|
folderPath | True | string |
The folder path under which to look for queries. |
Returns
A list of VSTS models.
List root level queries
Retrieves the list of root-level work item queries in a project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
Returns
A list of VSTS models.
List work item types
Retrieves the list of Work Item Types accessible in a given Azure DevOps project.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
Returns
A list of VSTS models.
- Body
- VstsListWorkItemType
List work items
Returns a list of work items.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
|
Work Item IDs
|
ids | True | string |
The comma-separated list of requested work item IDs. |
Returns
Update a work item
Update an existing work item by id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization Name
|
account | True | string |
The name of the Organization. This can be found in the instance URL i.e. {Organization}.visualstudio.com. The Organization should have "Third-party application access via OAuth" enabled to prevent errors in the operation. |
|
Work Item Id
|
id | True | string |
The unique id of the work item to update. |
|
Project Name
|
project | True | string |
The name of the project within the specified Organization. |
|
Priority
|
priority | integer |
The priority of the work item. |
|
|
Key
|
key | string |
The key of field |
|
|
value
|
value | string |
The value of field |
Returns
- response
- object
Definitions
VstsListAccount
A list of VSTS models.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of Account |
The VSTS Models |
Account
Account
| Name | Path | Type | Description |
|---|---|---|---|
|
Account Id
|
accountId | string |
The id of the account. |
|
Account URI
|
accountUri | string |
The URI of the account. |
|
Account Name
|
accountName | string |
The name of the account. |
|
Account Owner
|
accountOwner | string |
The set owner of the account. |
|
Organization Name
|
organizationName | string |
The organization name corresponding to the account. |
|
Account Type
|
accountType | string |
The type of the account. |
Profile
Profile
| Name | Path | Type | Description |
|---|---|---|---|
|
displayName
|
displayName | string |
Display Name of User |
|
id
|
id | string |
The unique identifier of the profile. |
|
publicAlias
|
publicAlias | string |
Public Alias. |
|
Email Address
|
emailAddress | string |
Email Address of the account. |
|
timeStamp
|
timeStamp | date-time |
The time at which this profile was last changed. |
|
revision
|
revision | integer |
The maximum revision number of any attribute. |
|
CoreRevision
|
coreRevision | integer |
CoreRevision |
VstsListProject
A list of VSTS models.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of Project |
The VSTS Models |
Project
Project
| Name | Path | Type | Description |
|---|---|---|---|
|
Project Id
|
id | string |
The unique identifier of the project. |
|
Project Name
|
name | string |
The name of the project. |
|
Project URL
|
url | string |
The API URL of the project. |
VstsListQueryHierarchyItem
A list of VSTS models.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of QueryHierarchyItem |
The VSTS Models |
QueryHierarchyItem
Query Hierarchy Item
| Name | Path | Type | Description |
|---|---|---|---|
|
Has Children
|
hasChildren | boolean |
Specifies whether the query hierarchy item has children. |
|
Id
|
id | string |
The unique identifer of the query hierarchy item. |
|
Is Folder
|
isFolder | boolean |
Specifies whether the query hierarchy item is a folder. |
|
Is Public
|
isPublic | boolean |
Specifies whether the query hierarchy item is public. |
|
Name
|
name | string |
The name of the query hierarchy item. |
|
Path
|
path | string |
The path of the query hierarchy item. |
|
Links
|
_links | object |
The collection of links relevant to the query hierarchy item. |
|
URL
|
url | string |
The full HTTP link to the query hierarchy item. |
VstsListWorkItemType
A list of VSTS models.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of WorkItemType |
The VSTS Models. |
WorkItemType
Work Item Type
| Name | Path | Type | Description |
|---|---|---|---|
|
Description
|
description | string |
The description of the type. |
|
Name
|
name | string |
The name of the type. |
|
icon Id
|
icon.id | string |
The identifier of the icon |
|
icon url
|
icon.url | string |
The REST URL of the resource |
|
States
|
states | array of WorkItemStateColor |
States of work item type |
WorkItemStateColor
Work Item State Color
| Name | Path | Type | Description |
|---|---|---|---|
|
category of state
|
category | string |
category of state |
|
Color value
|
color | string |
Color value |
|
state name
|
name | string |
Work item type state name |
VstsListListWorkItemResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of ListWorkItemResponse |
ListWorkItemResponse
Work Item Response for the List Work Items operation
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | integer |
The unique id of the work item. |
|
Area Path
|
areaPath | string |
The area path of the work item. |
|
Team Project
|
teamProject | string |
The team project to which the work item belongs. |
|
Iteration Path
|
iterationPath | string |
The iteration path of the work item. |
|
Work Item Type
|
workItemType | string |
The type of the work item. |
|
State
|
state | string |
The state of the work item. |
|
Reason
|
reason | string |
The reason entered for the work item. |
|
Changed Date
|
updatedAt | string |
The datetime the work item was changed. |
|
Due Date
|
dueDate | string |
The due date the work item. |
|
priority
|
priority | string |
priority |
|
Title
|
title | string |
The title of the work item. |
|
Tags
|
tags | string |
The tags of the work item. |
|
Assigned To
|
assignedTo | string |
The email of the team member who currently owns the work item. |
|
Assigned To Name
|
assignedToName | string |
The name of the team member who currently owns the work item. |
VstsListJObject
A list of VSTS models.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of Object |
The VSTS Models |
VstsListSubject
A list of Graph Subjects.
| Name | Path | Type | Description |
|---|---|---|---|
|
Value
|
value | array of Subject |
The Graph Subjects |
Subject
Subject Definition
| Name | Path | Type | Description |
|---|---|---|---|
|
DisplayName
|
displayName | string |
The unique identifier of the build definition. |
|
MailAddress
|
mailAddress | string |
Mail address of subject |
|
PrincipalName
|
principalName | string |
The principal name of the subject |
|
SubjectKind
|
subjectKind | string |
The principal name of the subject |
|
Avatar
|
avatar | string |
Avatar url |
Object
object
This is the type 'object'.