Dashboards - Get
Obtenga un panel por su identificador.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
dashboard
|
path | True |
string uuid |
|
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
project
|
path | True |
string |
Id. de proyecto o nombre del proyecto |
team
|
path |
string |
Id. de equipo o nombre del equipo |
|
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.3" para usar esta versión de la API. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta |
Seguridad
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
Nombre | Description |
---|---|
vso.dashboards | Concede la capacidad de leer la información del panel del equipo |
Ejemplos
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"
}
]
}
}
Definiciones
Nombre | Description |
---|---|
Dashboard |
Modelo de un panel. |
Dashboard |
Ámbito del panel. Puede ser Project o Project_Team |
Lightbox |
Configuración de lightbox |
Reference |
Clase que representa una colección de vínculos de referencia de REST. |
Semantic |
Control de versiones de un artefacto como se describe en: http://semver.org/, con el formato major.minor.patch. |
Widget |
Datos del widget |
Widget |
|
Widget |
Dashboard
Modelo de un panel.
Nombre | Tipo | Description |
---|---|---|
_links |
Clase que representa una colección de vínculos de referencia de REST. |
|
dashboardScope |
Entidad a la que se limita el panel. |
|
description |
string |
Descripción del panel. |
eTag |
string |
Valor de seguimiento de versiones definido por el servidor, que se usa para editar la detección de colisiones. |
groupId |
string |
Identificador del grupo de un panel. En el caso de los paneles con ámbito de equipo, este es el identificador único del equipo asociado al panel. En el caso de los paneles con ámbito de proyecto, esta propiedad está vacía. |
id |
string |
Id. del panel. Proporcionado por el servicio en el momento de la creación. |
lastAccessedDate |
string |
Fecha de último acceso del panel. |
modifiedBy |
string |
Identificador de la persona que modificó el panel. |
modifiedDate |
string |
Fecha de última modificación del panel. |
name |
string |
Nombre del panel. |
ownerId |
string |
Identificador del propietario de un panel. En el caso de los paneles con ámbito de equipo, este es el identificador único del equipo asociado al panel. En el caso de los paneles con ámbito de proyecto, este es el identificador único de la identidad de usuario asociada al panel. |
position |
integer |
Posición del panel, dentro de un grupo de paneles. Si no se establece en el momento de la creación, el servicio decide la posición. |
refreshInterval |
integer |
Intervalo para que el cliente actualice automáticamente el panel. Expresado en minutos. |
url |
string |
|
widgets |
Widget[] |
Conjunto de widgets en el panel. |
DashboardScope
Ámbito del panel. Puede ser Project o Project_Team
Nombre | Tipo | Description |
---|---|---|
collection_User |
string |
[EN DESUSO] El panel está en el ámbito del usuario de la colección. |
project |
string |
El panel está en el ámbito del proyecto. |
project_Team |
string |
El panel está en el ámbito del equipo. |
LightboxOptions
Configuración de lightbox
Nombre | Tipo | Description |
---|---|---|
height |
integer |
Alto de la caja de luz deseada, en píxeles |
resizable |
boolean |
True para permitir el cambio de tamaño de la caja de luz, false para no permitir el cambio de tamaño de la caja de luz, el valor predeterminado es false. |
width |
integer |
Ancho de la caja de luz deseada, en píxeles |
ReferenceLinks
Clase que representa una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
SemanticVersion
Control de versiones de un artefacto como se describe en: http://semver.org/, con el formato major.minor.patch.
Nombre | Tipo | Description |
---|---|---|
major |
integer |
Versión principal al realizar cambios de API incompatibles |
minor |
integer |
Versión secundaria al agregar funcionalidad de una manera compatible con versiones anteriores |
patch |
integer |
Versión de revisión al realizar correcciones de errores compatibles con versiones anteriores |
Widget
Datos del widget
Nombre | Tipo | Description |
---|---|---|
_links |
Clase que representa una colección de vínculos de referencia de REST. |
|
allowedSizes |
Hace referencia a los tamaños permitidos para el widget. Esto se rellena cuando el usuario quiere configurar el widget. |
|
areSettingsBlockedForUser |
boolean |
Read-Only propiedad del servicio dashboard. Indica si la configuración está bloqueada para el usuario actual. |
artifactId |
string |
Hace referencia al identificador único de un artefacto de característica. Se usa para anclar y desanclar un artefacto específico. |
configurationContributionId |
string |
|
configurationContributionRelativeId |
string |
|
contentUri |
string |
|
contributionId |
string |
Identificador de la contribución subyacente que define la configuración de widget proporcionada. |
dashboard |
Contenido de panel parcial opcional, para admitir el intercambio de ETag de la versión de nivel de panel para las API de nivel de widget |
|
eTag |
string |
|
id |
string |
|
isEnabled |
boolean |
|
isNameConfigurable |
boolean |
|
lightboxOptions |
Configuración de lightbox |
|
loadingImageUrl |
string |
|
name |
string |
|
position | ||
settings |
string |
|
settingsVersion |
Control de versiones de un artefacto como se describe en: http://semver.org/, con el formato major.minor.patch. |
|
size | ||
typeId |
string |
|
url |
string |
WidgetPosition
Nombre | Tipo | Description |
---|---|---|
column |
integer |
|
row |
integer |
WidgetSize
Nombre | Tipo | Description |
---|---|---|
columnSpan |
integer |
Ancho del widget, expresado en columnas de cuadrícula del panel. |
rowSpan |
integer |
Alto del widget, expresado en filas de cuadrícula del panel. |