Dashboards - Get
Получение панели мониторинга по ее идентификатору.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
dashboard
|
path | True |
string uuid |
|
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
Тип:
oauth2
Flow:
accessCode
URL-адрес авторизации:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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
Области
Имя | Описание |
---|---|
vso.dashboards | Предоставляет возможность чтения сведений о панели мониторинга группы |
Примеры
Образец запроса
GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025?api-version=7.1-preview.3
Пример ответа
{
"id": "759b486a-e22a-4692-bf40-e2deec0de530",
"name": "Overview",
"refreshInterval": 0,
"position": 1,
"eTag": "2",
"widgets": [
{
"id": "c64731a0-8c47-4b6e-92dc-25668e004e1d",
"eTag": "1",
"name": "Team Members",
"position": {
"row": 1,
"column": 6
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
},
{
"id": "3e55ea7a-46c6-43c5-ba0d-475093d4e483",
"eTag": "1",
"name": "Open User Stories",
"position": {
"row": 1,
"column": 3
},
"size": {
"rowSpan": 2,
"columnSpan": 3
},
"settings": "{\"query\":{\"queryId\":\"3c242d67-38f1-41d8-b8af-1f7fb218940d\", \"queryName\": \"Open User Stories\"}}",
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-mywork-web.Microsoft.VisualStudioOnline.MyWork.WitViewWidget"
},
{
"id": "615c113e-becc-48fa-8f86-5acf2cb6c0cd",
"eTag": "1",
"name": "Work Links",
"position": {
"row": 2,
"column": 6
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.WorkLinksWidget"
},
{
"id": "13635e90-277f-40f0-b601-7a08de067279",
"eTag": "1",
"name": "Open User Stories",
"position": {
"row": 3,
"column": 5
},
"size": {
"rowSpan": 1,
"columnSpan": 1
},
"settings": "{\"queryId\":\"3c242d67-38f1-41d8-b8af-1f7fb218940d\", \"queryName\": \"Open User Stories\"}",
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"artifactId": "",
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.QueryScalarWidget"
},
{
"id": "673670cc-8efc-4bf8-9dd8-7c83804bdf75",
"eTag": "1",
"name": "New Work Item",
"position": {
"row": 3,
"column": 3
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"artifactId": "",
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.NewWorkItemWidget",
"configurationContributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.NewWorkItemWidget.Configuration"
},
{
"id": "abd84deb-2c64-4df1-9b8b-92f9a7e29f77",
"eTag": "1",
"name": "Markdown",
"position": {
"row": 1,
"column": 8
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": "#####Markdown\nAdd content using the markdown widget.\n- **Bold**\n- *Italic*\n- [Links]()",
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.MarkdownWidget",
"configurationContributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.MarkdownWidget.Configuration"
},
{
"id": "07c1d6e4-ff3c-421a-a165-9fabd10ab623",
"eTag": "1",
"name": "Visual Studio Shortcuts",
"position": {
"row": 3,
"column": 6
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"artifactId": "",
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.VSLinksWidget"
},
{
"id": "af696a7f-2e1e-4068-92a6-af164de70cd5",
"eTag": "1",
"name": "Sprint Burndown",
"position": {
"row": 3,
"column": 1
},
"size": {
"rowSpan": 1,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.SprintBurndownWidget"
},
{
"id": "f2329867-71ea-4a77-a676-e1a98263e4bd",
"eTag": "1",
"name": "Welcome",
"position": {
"row": 1,
"column": 1
},
"size": {
"rowSpan": 2,
"columnSpan": 2
},
"settings": null,
"settingsVersion": {
"major": 1,
"minor": 0,
"patch": 0
},
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets"
},
"dashboard": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
}
},
"contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.HowToLinksWidget"
}
],
"url": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards/759b486a-e22a-4692-bf40-e2deec0de530"
},
"group": {
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/Dashboards"
},
"widget": [
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/c64731a0-8c47-4b6e-92dc-25668e004e1d"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/3e55ea7a-46c6-43c5-ba0d-475093d4e483"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/615c113e-becc-48fa-8f86-5acf2cb6c0cd"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/13635e90-277f-40f0-b601-7a08de067279"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/673670cc-8efc-4bf8-9dd8-7c83804bdf75"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/abd84deb-2c64-4df1-9b8b-92f9a7e29f77"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/07c1d6e4-ff3c-421a-a165-9fabd10ab623"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/af696a7f-2e1e-4068-92a6-af164de70cd5"
},
{
"href": "https://dev.azure.com/fabrikam/969d9ce2-8aa1-40b5-86e6-2eb7f583d6c4/c21744ff-6194-4860-80ff-0baaf853baca/_apis/Dashboard/dashboards/759b486a-e22a-4692-bf40-e2deec0de530/Widgets/f2329867-71ea-4a77-a676-e1a98263e4bd"
}
]
}
}
Определения
Имя | Описание |
---|---|
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 |
[НЕ РЕКОМЕНДУЕТСЯ] Область панели мониторинга ограничена пользователем коллекции. |
project |
Панель мониторинга ограничена проектом. |
project_Team |
Область панели мониторинга ограничена командой. |
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 |
Высота мини-приложения, выраженная в строках сетки панели мониторинга. |