Dashboards - List
Получение списка панелей мониторинга в проекте.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
project
|
path | True |
string |
Идентификатор или имя проекта |
team
|
path |
string |
Идентификатор или имя команды |
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.3. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
успешная операция |
Безопасность
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
Имя | Описание |
---|---|
vso.dashboards | Предоставляет возможность считывания сведений о панели мониторинга команды |
Примеры
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards?api-version=7.1-preview.3
Sample Response
{
"count": 2,
"value": [
{
"id": "29653dd2-c18a-4d19-8333-e556c5b8d025",
"name": "Overview",
"refreshInterval": 0,
"position": 1,
"groupId": "091a34b6-9a63-40fd-acae-7716353dde05",
"ownerId": "091a34b6-9a63-40fd-acae-7716353dde05",
"dashboardScope": "project_Team",
"url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025"
},
"group": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards"
}
}
},
{
"id": "48ab8210-0463-48b7-aa0f-75d74fdfee95",
"name": "p2",
"refreshInterval": 0,
"position": 2,
"eTag": "1",
"ownerId": "99c3b95a-7504-4652-8609-59af5637d920",
"dashboardScope": "project",
"url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/ad633947-f99b-4813-bfc6-b67b7e687b0e",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards/ad633947-f99b-4813-bfc6-b67b7e687b0e"
},
"group": {
"href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/_apis/Dashboard/Dashboards"
}
}
}
]
}
Определения
Имя | Описание |
---|---|
Dashboard |
Модель панели мониторинга. |
Dashboard |
Область панели мониторинга. Может быть либо Project, либо Project_Team |
Lightbox |
Конфигурация Lightbox |
Reference |
Класс, представляющий коллекцию ссылок REST. |
Semantic |
управление версиями для артефакта, как описано в: http://semver.org/, в форме major.minor.patch. |
Widget |
Данные мини-приложения |
Widget |
|
Widget |
Dashboard
Модель панели мониторинга.
Имя | Тип | Описание |
---|---|---|
_links |
Класс, представляющий коллекцию ссылок REST. |
|
dashboardScope |
Сущность, область действия которой ограничена панелью мониторинга. |
|
description |
string |
Описание панели мониторинга. |
eTag |
string |
Заданное сервером значение отслеживания версии, используемое для изменения обнаружения конфликтов. |
groupId |
string |
Идентификатор группы для панели мониторинга. Для панелей мониторинга в области группы это уникальный идентификатор команды, связанной с панелью мониторинга. Для панелей мониторинга в области проекта это свойство пусто. |
id |
string |
Идентификатор панели мониторинга. Предоставляется службой во время создания. |
lastAccessedDate |
string |
Дата последнего обращения к панели мониторинга. |
modifiedBy |
string |
Идентификатор пользователя, изменившего панель мониторинга. |
modifiedDate |
string |
Дата последнего изменения панели мониторинга. |
name |
string |
Имя панели мониторинга. |
ownerId |
string |
Идентификатор владельца панели мониторинга. Для панелей мониторинга в области группы это уникальный идентификатор команды, связанной с панелью мониторинга. Для панелей мониторинга в области проекта это уникальный идентификатор удостоверения пользователя, связанного с панелью мониторинга. |
position |
integer |
Положение панели мониторинга в группе панелей мониторинга. Если во время создания не задано, то позиция определяется службой. |
refreshInterval |
integer |
Интервал автоматического обновления панели мониторинга клиентом. Выражается в минутах. |
url |
string |
|
widgets |
Widget[] |
Набор мини-приложений на панели мониторинга. |
DashboardScope
Область панели мониторинга. Может быть либо Project, либо Project_Team
Имя | Тип | Описание |
---|---|---|
collection_User |
string |
[НЕ РЕКОМЕНДУЕТСЯ] Панель мониторинга ограничена пользователем коллекции. |
project |
string |
Панель мониторинга ограничена проектом. |
project_Team |
string |
Панель мониторинга ограничена командой. |
LightboxOptions
Конфигурация Lightbox
Имя | Тип | Описание |
---|---|---|
height |
integer |
Высота нужного лайтбокса в пикселях |
resizable |
boolean |
Значение true, чтобы разрешить изменение размера лайтбоксов, значение false , чтобы запретить изменение размера лайтбоксов, по умолчанию — false. |
width |
integer |
Ширина нужного лайтбокса в пикселях |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |
SemanticVersion
управление версиями для артефакта, как описано в: http://semver.org/, в форме major.minor.patch.
Имя | Тип | Описание |
---|---|---|
major |
integer |
Основная версия при внесении несовместимых изменений API |
minor |
integer |
Дополнительная версия при добавлении функций с обратной совместимостью |
patch |
integer |
Версия исправлений при внесении исправлений ошибок, совместимых с обратной совместимостью |
Widget
Данные мини-приложения
Имя | Тип | Описание |
---|---|---|
_links |
Класс, представляющий коллекцию ссылок REST. |
|
allowedSizes |
Ссылается на допустимые размеры мини-приложения. Он заполняется, когда пользователь хочет настроить мини-приложение. |
|
areSettingsBlockedForUser |
boolean |
Read-Only свойство из службы панели мониторинга. Указывает, заблокированы ли параметры для текущего пользователя. |
artifactId |
string |
Относится к уникальному идентификатору артефакта компонента. Используется для закрепления и открепления определенного артефакта. |
configurationContributionId |
string |
|
configurationContributionRelativeId |
string |
|
contentUri |
string |
|
contributionId |
string |
Идентификатор базового вклада, определяющий предоставленную конфигурацию мини-приложения. |
dashboard |
Необязательное частичное содержимое панели мониторинга для поддержки обмена версией ETag на уровне панели мониторинга для API уровня мини-приложения |
|
eTag |
string |
|
id |
string |
|
isEnabled |
boolean |
|
isNameConfigurable |
boolean |
|
lightboxOptions |
Конфигурация Lightbox |
|
loadingImageUrl |
string |
|
name |
string |
|
position | ||
settings |
string |
|
settingsVersion |
управление версиями для артефакта, как описано в: http://semver.org/, в форме major.minor.patch. |
|
size | ||
typeId |
string |
|
url |
string |
WidgetPosition
Имя | Тип | Описание |
---|---|---|
column |
integer |
|
row |
integer |
WidgetSize
Имя | Тип | Описание |
---|---|---|
columnSpan |
integer |
Ширина мини-приложения, выраженная в столбцах сетки панели мониторинга. |
rowSpan |
integer |
Высота мини-приложения, выраженная в строках сетки панели мониторинга. |
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по