Taskboard Columns - Update

PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/work/taskboardcolumns?api-version=7.1

URI Parameters

Name In Required Type Description
organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

team
path True

string

Team ID or team name

api-version
query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name Type Description
body

UpdateTaskboardColumn[]

Responses

Name Type Description
200 OK

TaskboardColumns

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.work_write Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks.

Definitions

Name Description
ITaskboardColumnMapping
TaskboardColumn

Represents the taskbord column

TaskboardColumnMapping

Represents the state to column mapping per work item type This allows auto state update when the column changes

TaskboardColumns
UpdateTaskboardColumn

ITaskboardColumnMapping

Name Type Description
state

string

workItemType

string

TaskboardColumn

Represents the taskbord column

Name Type Description
id

string

Column ID

mappings

ITaskboardColumnMapping[]

Work item type states mapped to this column to support auto state update when column is updated.

name

string

Column name

order

integer

Column position relative to other columns in the same board

TaskboardColumnMapping

Represents the state to column mapping per work item type This allows auto state update when the column changes

Name Type Description
state

string

State of the work item type mapped to the column

workItemType

string

Work Item Type name who's state is mapped to the column

TaskboardColumns

Name Type Description
columns

TaskboardColumn[]

Represents the taskbord column

isCustomized

boolean

Are the columns cutomized for this team

isValid

boolean

Specifies if the referenced WIT and State is valid

validationMesssage

string

Details of validation failure if the state to column mapping is invalid

UpdateTaskboardColumn

Name Type Description
id

string

Column ID, keep it null for new column

mappings

TaskboardColumnMapping[]

Work item type states mapped to this column to support auto state update when column is updated.

name

string

Column name is required

order

integer

Column position relative to other columns in the same board