Widgets - Get Widget

Referencia

Service:: Dashboard

API Version:: 7.1-preview.2

Obtiene el estado actual del widget especificado.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId}?api-version=7.1-preview.2

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
dashboardId	path	True	string uuid	Identificador del panel que contiene el widget.
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
widgetId	path	True	string uuid	Identificador del widget que se va a leer.
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.2" para usar esta versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	Widget	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

HTTP

GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf?api-version=7.1-preview.2

Sample Response

Status code:: 200

{
  "id": "69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "eTag": "5",
  "name": "Other Links",
  "position": {
    "row": 1,
    "column": 1
  },
  "size": {
    "rowSpan": 1,
    "columnSpan": 2
  },
  "settings": null,
  "settingsVersion": {
    "major": 1,
    "minor": 0,
    "patch": 0
  },
  "dashboard": {
    "eTag": "18"
  },
  "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.OtherLinksWidget",
  "url": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets"
    },
    "dashboard": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a"
    }
  }
}

Definiciones

Nombre	Description
Dashboard	Modelo de un panel.
DashboardScope	Ámbito del panel. Puede ser Project o Project_Team
LightboxOptions	Configuración de lightbox
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
SemanticVersion	Control de versiones de un artefacto como se describe en: http://semver.org/, con el formato major.minor.patch.
Widget	Datos del widget
WidgetPosition
WidgetSize

Dashboard

Modelo de un panel.

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
dashboardScope	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

Datos del widget

Nombre	Tipo	Description
_links	ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
allowedSizes	WidgetSize[]	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	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	LightboxOptions	Configuración de lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	Control de versiones de un artefacto como se describe en: http://semver.org/, con el formato major.minor.patch.
size	WidgetSize
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.

Compartir a través de