Dashboards - Get
Rufen Sie einen Dashboard anhand seiner ID ab.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
dashboard
|
path | True |
string uuid |
|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
project
|
path | True |
string |
Projekt-ID oder Projektname |
team
|
path |
string |
Team-ID oder Teamname |
|
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreicher Vorgang |
Sicherheit
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
Name | Beschreibung |
---|---|
vso.dashboards | Ermöglicht das Lesen von Team-Dashboard Informationen |
Beispiele
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025?api-version=7.1-preview.3
Sample Response
{
"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"
}
]
}
}
Definitionen
Name | Beschreibung |
---|---|
Dashboard |
Modell eines Dashboards. |
Dashboard |
Dashboardbereich. Kann entweder Project oder Project_Team sein. |
Lightbox |
Lightbox-Konfiguration |
Reference |
Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
Semantic |
Versionsverwaltung für ein Artefakt, wie unter beschrieben, http://semver.org/der Form "major.minor.patch". |
Widget |
Widgetdaten |
Widget |
|
Widget |
Dashboard
Modell eines Dashboards.
Name | Typ | Beschreibung |
---|---|---|
_links |
Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
|
dashboardScope |
Entität, auf die der bereichsbezogene Dashboard. |
|
description |
string |
Beschreibung des Dashboard. |
eTag |
string |
Serverdefinierter Versionsnachverfolgungswert, der zum Bearbeiten der Kollisionserkennung verwendet wird. |
groupId |
string |
ID der Gruppe für eine Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei Projektbereichsdashboards ist diese Eigenschaft leer. |
id |
string |
ID des Dashboards. Wird zum Zeitpunkt der Erstellung vom Dienst bereitgestellt. |
lastAccessedDate |
string |
Dashboarddatum des letzten Zugriffs. |
modifiedBy |
string |
ID der Person, die das Dashboard geändert hat. |
modifiedDate |
string |
Das Datum der letzten Änderung des Dashboards. |
name |
string |
Name des Dashboards. |
ownerId |
string |
ID des Besitzers für eine Dashboard. Bei Dashboards im Teambereich ist dies der eindeutige Bezeichner für das Team, das dem Dashboard zugeordnet ist. Bei Dashboards im Projektbereich ist dies der eindeutige Bezeichner für die Benutzeridentität, die dem Dashboard zugeordnet ist. |
position |
integer |
Position des Dashboard innerhalb einer Dashboard Gruppe. Wenn die Einstellung zum Zeitpunkt der Erstellung nicht festgelegt wird, wird die Position vom Dienst festgelegt. |
refreshInterval |
integer |
Intervall, in dem der Client die Dashboard automatisch aktualisiert. Ausgedrückt in Minuten. |
url |
string |
|
widgets |
Widget[] |
Der Satz von Widgets auf der Dashboard. |
DashboardScope
Dashboardbereich. Kann entweder Project oder Project_Team sein.
Name | Typ | Beschreibung |
---|---|---|
collection_User |
string |
[VERALTET] Das Dashboard ist auf den Sammlungsbenutzer ausgerichtet. |
project |
string |
Das Dashboard ist auf das Projekt ausgerichtet. |
project_Team |
string |
Das Dashboard ist auf das Team ausgerichtet. |
LightboxOptions
Lightbox-Konfiguration
Name | Typ | Beschreibung |
---|---|---|
height |
integer |
Höhe des gewünschten Lightboxfelds in Pixel |
resizable |
boolean |
True, um die Größe von Lightboxen zu ändern, false, um die Größe des Lightboxs nicht zuzulassen, standardwertlich auf false. |
width |
integer |
Breite des gewünschten Lightboxfelds in Pixel |
ReferenceLinks
Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
Name | Typ | Beschreibung |
---|---|---|
links |
object |
Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen. |
SemanticVersion
Versionsverwaltung für ein Artefakt, wie unter beschrieben, http://semver.org/der Form "major.minor.patch".
Name | Typ | Beschreibung |
---|---|---|
major |
integer |
Hauptversion, wenn Sie inkompatible API-Änderungen vornehmen |
minor |
integer |
Nebenversion, wenn Sie Funktionen abwärtskompatibel hinzufügen |
patch |
integer |
Patchversion bei abwärtskompatiblen Fehlerbehebungen |
Widget
Widgetdaten
Name | Typ | Beschreibung |
---|---|---|
_links |
Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
|
allowedSizes |
Bezieht sich auf die zulässigen Größen für das Widget. Diese wird aufgefüllt, wenn der Benutzer das Widget konfigurieren möchte. |
|
areSettingsBlockedForUser |
boolean |
Read-Only-Eigenschaft des Dashboarddiensts. Gibt an, ob Einstellungen für den aktuellen Benutzer blockiert sind. |
artifactId |
string |
Bezieht sich auf den eindeutigen Bezeichner eines Featureartefakts. Wird zum Anheften und Lösen eines bestimmten Artefakts verwendet. |
configurationContributionId |
string |
|
configurationContributionRelativeId |
string |
|
contentUri |
string |
|
contributionId |
string |
Die ID des zugrunde liegenden Beitrags, der die angegebene Widgetkonfiguration definiert. |
dashboard |
Optionaler Teilinhalt Dashboard, um den Austausch Dashboard Version ETag gegen APIs auf Widgetebene zu unterstützen |
|
eTag |
string |
|
id |
string |
|
isEnabled |
boolean |
|
isNameConfigurable |
boolean |
|
lightboxOptions |
Lightbox-Konfiguration |
|
loadingImageUrl |
string |
|
name |
string |
|
position | ||
settings |
string |
|
settingsVersion |
Versionsverwaltung für ein Artefakt, wie unter beschrieben, http://semver.org/der Form "major.minor.patch". |
|
size | ||
typeId |
string |
|
url |
string |
WidgetPosition
Name | Typ | Beschreibung |
---|---|---|
column |
integer |
|
row |
integer |
WidgetSize
Name | Typ | Beschreibung |
---|---|---|
columnSpan |
integer |
Die Breite des Widgets, ausgedrückt in Dashboard Rasterspalten. |
rowSpan |
integer |
Die Höhe des Widgets, ausgedrückt in Dashboard Rasterzeilen. |