Charts - Get

Get a board chart

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/boards/{board}/charts/{name}?api-version=7.1

URI Parameters

Name In Required Type Description
board
path True

string

Identifier for board, either board's backlog level name (Eg:"Stories") or Id

name
path True

string

The chart name

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

team
path

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.

Responses

Name Type Description
200 OK

BoardChart

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 Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Definitions

Name Description
BoardChart
ReferenceLinks

The class to represent a collection of REST reference links.

BoardChart

Name Type Description
_links

ReferenceLinks

The links for the resource

name

string

Name of the resource

settings

object

The settings for the resource

url

string

Full http link to the resource

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.