Excel Add-In for Azure DevOps

Build 24.0.9060

Dashboards

Retrieves a list of dashboards and details for a specific dashboard.

Table Specific Information

Select

The add-in uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:

  • Id supports the '=' operator.
  • ProjectId supports the '=' operator.
  • TeamId supports the '=' operator.
The rest of the filter is executed client-side in the add-in.

For example:

SELECT * FROM Dashboards WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf'
SELECT * FROM Dashboards WHERE ProjectId = '837ccd31-8159-4db3-b8ce-de0c36d2a0bf' AND TeamId = '27369296-c53e-4f21-9cac-1f0d62c87e40'

Insert

The following is an example of inserting into the Dashboards table:

INSERT INTO DashBoards (ProjectId, TeamId, Name, Description) VALUES ('b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937', '619e870e-5242-4218-bedd-c52d8c003591', 'hello@123y', 'demo dashboards')

Update

The following is an example of updating the Dashboards table:

UPDATE DashBoards SET Name = 'abc' WHERE ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND Id = 'd112a62e-5fa1-42eb-abcc-2272cdceefe0' AND TeamId = '619e870e-5242-4218-bedd-c52d8c003591'

Delete

Due to the fact that there is no way to distinguish between the API response for a successful and a failed DELETE for this table, the affected row count is always -1.

The following is an example of deleting data ftom the Dashboards table:

DELETE FROM DashBoards WHERE ProjectId = 'b154d8f3-bfd9-4bfb-90ae-2e6c8cda8937' AND Id = 'd112a62e-5fa1-42eb-abcc-2272cdceefe0' AND TeamId = '619e870e-5242-4218-bedd-c52d8c003591'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique Id of the dashboard.

ProjectId String True

The Id of the project to which this dashboard belongs to.

TeamId String True

The Id fo the team to which this dashboard belongs to.

Description String False

Description of the dashboard.

ETag String False

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

Name String False

Name of the dashboard.

OwnerId String False

ID of the owner for a dashboard.

GroupId String True

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.

Position Integer False

Position of the dashboard, within a dashboard group.

RefreshInterval Integer False

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

Url String False

The full HTTP link to the dashboard.

LastAccessedDate String True

Date when the dashboard was last accessed.

ModifiedDate String True

Date when the dashboard was last modified.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060