Dashboard interface

  • Reference
Package:
azure-devops-extension-api

Model of a Dashboard.

Properties

dashboardScope

Entity to which the dashboard is scoped.
description

Description of the dashboard.
eTag

Server defined version tracking value, used for edit collision detection.
globalParametersConfig

Dashboard Global Parameters Config
groupId

ID of the group for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards this property is empty.
id

ID of the Dashboard. Provided by service at creation time.
lastAccessedDate

Dashboard Last Accessed Date.
modifiedBy

Id of the person who modified Dashboard.
modifiedDate

Dashboard's last modified date.
name

Name of the Dashboard.
ownerId

ID of the owner for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards, this is the unique identifier for the user identity associated with the dashboard.
position

Position of the dashboard, within a dashboard group. If unset at creation time, position is decided by the service.
refreshInterval

Interval for client to automatically refresh the dashboard. Expressed in minutes.
url
widgets

The set of Widgets on the dashboard.

Property Details

dashboardScope

Entity to which the dashboard is scoped.

dashboardScope: DashboardScope

Property Value

DashboardScope

description

Description of the dashboard.

description: string

Property Value

string

eTag

Server defined version tracking value, used for edit collision detection.

eTag: string

Property Value

string

globalParametersConfig

Dashboard Global Parameters Config

globalParametersConfig: string

Property Value

string

groupId

ID of the group for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards this property is empty.

groupId: string

Property Value

string

id

ID of the Dashboard. Provided by service at creation time.

id: string

Property Value

string

lastAccessedDate

Dashboard Last Accessed Date.

lastAccessedDate: Date

Property Value

Date

modifiedBy

Id of the person who modified Dashboard.

modifiedBy: string

Property Value

string

modifiedDate

Dashboard's last modified date.

modifiedDate: Date

Property Value

Date

name

Name of the Dashboard.

name: string

Property Value

string

ownerId

ID of the owner for a dashboard. For team-scoped dashboards, this is the unique identifier for the team associated with the dashboard. For project-scoped dashboards, this is the unique identifier for the user identity associated with the dashboard.

ownerId: string

Property Value

string

position

Position of the dashboard, within a dashboard group. If unset at creation time, position is decided by the service.

position: number

Property Value

number

refreshInterval

Interval for client to automatically refresh the dashboard. Expressed in minutes.

refreshInterval: number

Property Value

number

url 

url: string

Property Value

string

widgets

The set of Widgets on the dashboard.

widgets: Widget[]

Property Value

Widget[]