Class DashboardsApi

Hierarchy

DashboardsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DashboardsApi(basePath?: string): DashboardsApi

- Defined in api/api.ts:40184
Parameters
- Optional basePath: string
Returns DashboardsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createDashboard

createDashboard(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Dashboard>

- Defined in api/api.ts:40201
Create the supplied dashboard.

Parameters
- params: object
  - apiVersion: string
  - body: Dashboard
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Dashboard>

deleteDashboard

deleteDashboard(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:40267
Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.

Parameters
- params: object
  - apiVersion: string
  - dashboardId: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getDashboard

getDashboard(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Dashboard>

- Defined in api/api.ts:40331
Get a dashboard by its ID.

Parameters
- params: object
  - apiVersion: string
  - dashboardId: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Dashboard>

getDashboards

getDashboards(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<DashboardGroup>

- Defined in api/api.ts:40394
Get a list of dashboards.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<DashboardGroup>

replaceDashboard

replaceDashboard(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Dashboard>

- Defined in api/api.ts:40454
Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.

Parameters
- params: object
  - apiVersion: string
  - body: Dashboard
  - dashboardId: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Dashboard>

replaceDashboards

replaceDashboards(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<DashboardGroup>

- Defined in api/api.ts:40525
Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.

Parameters
- params: object
  - apiVersion: string
  - body: DashboardGroup
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<DashboardGroup>

Generated using TypeDoc