Dashboards - Get
Obtenha um dashboard por sua ID.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
dashboard
|
path | True |
string uuid |
|
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
project
|
path | True |
string |
ID do projeto ou nome do projeto |
|
team
|
path |
string |
ID da equipe ou nome da equipe |
|
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar essa versão da api. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
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
| Nome | Description |
|---|---|
| vso.dashboards | Concede a capacidade de ler informações de dashboard da equipe |
Exemplos
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"
}
]
}
}Definições
| Nome | Description |
|---|---|
| Dashboard |
Modelo de um Painel. |
|
Dashboard |
Escopo do Painel. Pode ser Project ou Project_Team |
|
Lightbox |
Configuração do Lightbox |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Semantic |
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch. |
| Widget |
Dados do widget |
|
Widget |
|
|
Widget |
Dashboard
Modelo de um Painel.
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| dashboardScope |
Entidade à qual o dashboard está no escopo. |
|
| description |
string |
Descrição do dashboard. |
| eTag |
string |
Valor de acompanhamento de versão definido pelo servidor, usado para editar a detecção de colisão. |
| groupId |
string |
ID do grupo para um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo para a equipe associada ao dashboard. Para painéis com escopo de projeto, essa propriedade está vazia. |
| id |
string |
ID do Painel. Fornecido pelo serviço no momento da criação. |
| lastAccessedDate |
string |
Data do Último Acesso do Painel. |
| modifiedBy |
string |
Id da pessoa que modificou o Painel. |
| modifiedDate |
string |
Data da última modificação do painel. |
| name |
string |
Nome do Painel. |
| ownerId |
string |
ID do proprietário de um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo para a equipe associada ao dashboard. Para painéis com escopo de projeto, esse é o identificador exclusivo para a identidade do usuário associada ao dashboard. |
| position |
integer |
Posição do dashboard, em um grupo de dashboard. Se não estiver definido no momento da criação, a posição será decidida pelo serviço. |
| refreshInterval |
integer |
Intervalo para o cliente atualizar automaticamente o dashboard. Expresso em minutos. |
| url |
string |
|
| widgets |
Widget[] |
O conjunto de Widgets no dashboard. |
DashboardScope
Escopo do Painel. Pode ser Project ou Project_Team
| Nome | Tipo | Description |
|---|---|---|
| collection_User |
string |
[PRETERIDO] O painel tem como escopo o usuário da coleção. |
| project |
string |
O painel tem como escopo o projeto. |
| project_Team |
string |
O painel tem o escopo definido para a equipe. |
LightboxOptions
Configuração do Lightbox
| Nome | Tipo | Description |
|---|---|---|
| height |
integer |
Altura da caixa de luz desejada, em pixels |
| resizable |
boolean |
True para permitir o redimensionamento de lightbox, false para não permitir o redimensionamento de lightbox, o padrão é false. |
| width |
integer |
Largura da caixa de luz desejada, em pixels |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
| Nome | Tipo | Description |
|---|---|---|
| links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
SemanticVersion
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch.
| Nome | Tipo | Description |
|---|---|---|
| major |
integer |
Versão principal quando você faz alterações incompatíveis na API |
| minor |
integer |
Versão secundária quando você adiciona funcionalidade de maneira compatível com versões anteriores |
| patch |
integer |
Versão do patch quando você faz correções de bug compatíveis com versões anteriores |
Widget
Dados do widget
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| allowedSizes |
Refere-se aos tamanhos permitidos para o widget. Isso é preenchido quando o usuário deseja configurar o widget |
|
| areSettingsBlockedForUser |
boolean |
propriedade Read-Only do Dashboard Service. Indica se as configurações estão bloqueadas para o usuário atual. |
| artifactId |
string |
Refere-se ao identificador exclusivo de um artefato de recurso. Usado para fixar+desafixar um artefato específico. |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
A ID da contribuição subjacente que define a Configuração de Widget fornecida. |
| dashboard |
Conteúdo de dashboard parcial opcional, para dar suporte à troca de ETag de versão no nível dashboard para APIs no nível do widget |
|
| eTag |
string |
|
| id |
string |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Configuração do Lightbox |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch. |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Nome | Tipo | Description |
|---|---|---|
| column |
integer |
|
| row |
integer |
WidgetSize
| Nome | Tipo | Description |
|---|---|---|
| columnSpan |
integer |
A Largura do widget, expressa em dashboard colunas de grade. |
| rowSpan |
integer |
A altura do widget, expressa em linhas de grade dashboard. |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários