Share via


Chartimages - Get Iterations Chart Image

Get an iterations chart image.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/iterations/chartimages/{name}?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/iterations/chartimages/{name}?iterationsNumber={iterationsNumber}&width={width}&height={height}&showDetails={showDetails}&title={title}&api-version=7.1

URI Parameters

Name In Required Type Description
name
path True

string

The chart name. e.g. Velocity.

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.

height
query

integer (int32)

The height of the chart in pixels. Must be greater than 0.

iterationsNumber
query

integer (int32)

Number of iterations the chart is for.

showDetails
query

boolean

Whether or not the chart should include detailed information (e.g. axis labels, titles, trend lines, etc.)

title
query

string

The title of the chart. Can only be dislayed if ShowLabels is true.

width
query

integer (int32)

The width of the chart in pixels. Must be greater than 0.

Responses

Name Type Description
200 OK

string

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.