Widget Types - Get Widget Metadata

Referencia

Servicio:: Dashboard

Versión de la API:: 7.1-preview.1

Obtiene los metadatos del widget que satisfacen el identificador de contribución especificado.

GET https://dev.azure.com/{organization}/{project}/_apis/dashboard/widgettypes/{contributionId}?api-version=7.1-preview.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
contributionId	path	True	string	Identificador de contribución para el widget
organization	path	True	string	Nombre de la organización de Azure DevOps.
project	path		string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	WidgetMetadataResponse	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre	Description
vso.dashboards	Concede la capacidad de leer la información del panel del equipo

Ejemplos

Solicitud de ejemplo

HTTP

GET https://dev.azure.com/fabrikam/_apis/dashboard/widgettypes/{contributionId}?api-version=7.1-preview.1

Respuesta de muestra

status code:: 200

{
  "widgetMetadata": {
    "typeId": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
    "name": "Other Links Widget",
    "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
    "description": "Shows relavant links for the team.",
    "isVisibleFromCatalog": true,
    "isEnabled": true,
    "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
    "allowedSizes": [
      {
        "rowSpan": 1,
        "columnSpan": 2
      }
    ],
    "contribution": {
      "extension": {
        "id": "bfb0eae0-a71f-469d-a021-9e650546db6b",
        "namespace": "dashboards.other-links",
        "version": "0.0.1",
        "name": "Other Links Widget",
        "description": "Shows relavant links for the team",
        "provider": {
          "name": "Microsoft",
          "website": "https://www.microsoft.com"
        },
        "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
        "contributions": {
          "vs.Dashboards.web#widget": [
            {
              "id": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
              "name": "Other Links Widget",
              "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
              "description": "Shows relavant links for the team.",
              "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
              "supportedSizes": [
                {
                  "rowSpan": 1,
                  "columnSpan": 2
                }
              ]
            }
          ]
        },
        "publishInfo": {
          "store": {
            "extensionStoreType": "builtIn",
            "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
          },
          "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
          "lastUpdated": "2015-05-12T21:18:54.827Z"
        }
      },
      "point": {
        "extensionNamespace": "vs.Dashboards.web",
        "extensionRelativeId": "widget",
        "id": "vs.Dashboards.web#widget"
      },
      "properties": {
        "id": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
        "name": "Other Links Widget",
        "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
        "description": "Shows relavant links for the team.",
        "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
        "supportedSizes": [
          {
            "rowSpan": 1,
            "columnSpan": 2
          }
        ]
      }
    }
  },
  "uri": "https://dev.azure.com/fabrikam/_apis/Dashboard/WidgetTypes/Microsoft.VisualStudioOnline.Dashboards.OtherLinks"
}

Definiciones

Nombre	Description
LightboxOptions	Configuración de Lightbox
WidgetMetadata	Información basada en la contribución que describe widgets de panel.
WidgetMetadataResponse
WidgetScope	Contrato de datos necesario para que el widget funcione y funcione en su contenedor.
WidgetSize

LightboxOptions

Object

Configuración de Lightbox

Nombre	Tipo	Description
height	integer (int32)	Alto de la bandeja 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 (int32)	Ancho de la bandeja de luz deseada, en píxeles

WidgetMetadata

Object

Información basada en la contribución que describe widgets de panel.

Nombre	Tipo	Description
allowedSizes	WidgetSize[]	Tamaños admitidos por el Widget.
analyticsServiceRequired	boolean	Boolean opcional que indica si el widget requiere que el servicio analytics funcione. Los widgets que requieren el servicio de análisis están ocultos en el catálogo si el servicio analytics no está disponible.
catalogIconUrl	string	Recurso para un icono en el catálogo de widgets.
catalogInfoUrl	string	Cadena de dirección URL de participación que apunta a la información del widget. El valor predeterminado es la dirección URL de Marketplace de extensión si se omite.
configurationContributionId	string	Identificador de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.
configurationContributionRelativeId	string	Identificador relativo de la contribución subyacente que define la interfaz de usuario de configuración personalizada del widget proporcionada. Null si la interfaz de usuario de configuración personalizada no está disponible.
configurationRequired	boolean	Indica si el widget requiere configuración antes de agregarse al panel.
contentUri	string	Uri del contenido del widget que se va a cargar desde .
contributionId	string	Identificador de la contribución subyacente que define el Widget proporcionado.
defaultSettings	string	Configuración predeterminada opcional que se va a copiar en la configuración del widget.
description	string	Información de resumen que describe el widget.
isEnabled	boolean	La tienda de aplicaciones puede deshabilitar los widgets. Necesitaremos controlar correctamente para: - persistencia (Permitir): solicitudes (etiqueta como deshabilitadas y proporcionar contexto)
isNameConfigurable	boolean	Opt-out boolean que indica si el widget admite la configuración de nombre o título del widget. Los widgets que ignoran el nombre deben establecerlo en false en el manifiesto.
isVisibleFromCatalog	boolean	Opt-out boolean que indica si el widget está oculto en el catálogo. Normalmente, esto se usa para permitir que los desarrolladores deshabiliten la creación de un widget en desuso. Un widget debe tener un estado predeterminado funcional o tener una experiencia de configuración para que sea visible desde el catálogo.
keywords	string[]	Palabras clave asociadas a este widget, no filtrables e invisibles
lightboxOptions	LightboxOptions	Propiedades de participación para personalizar la presentación del widget en un cuadro de diálogo "lightbox".
loadingImageUrl	string	Recurso para una imagen de marcador de posición de carga en el panel
name	string	Nombre orientado al usuario del tipo de widget. Cada widget debe usar un valor único aquí.
publisherName	string	Nombre del publicador de este tipo de widget.
supportedScopes	WidgetScope[]	Contrato de datos necesario para que el widget funcione y funcione en su contenedor.
tags	string[]	Etiquetas asociadas a este widget, visibles en cada widget y filtrables.
targets	string[]	Identificadores de destino de contribución
typeId	string	En desuso: identificador localmente único para desarrolladores de este tipo de widget. ContributionId proporciona un identificador único global para los tipos de widget.

WidgetMetadataResponse

Object

Nombre	Tipo	Description
uri	string
widgetMetadata	WidgetMetadata	Información basada en la contribución que describe widgets de panel.

WidgetScope

Enumeración

Contrato de datos necesario para que el widget funcione y funcione en su contenedor.

Valor	Description
collection_User
project_Team

WidgetSize

Object

Nombre	Tipo	Description
columnSpan	integer (int32)	Ancho del widget, expresado en columnas de cuadrícula del panel.
rowSpan	integer (int32)	Alto del widget, expresado en filas de cuadrícula del panel.

Compartir a través de

Widget Types - Get Widget Metadata

Parámetros de identificador URI

Respuestas

Seguridad

oauth2

Ámbitos

Ejemplos

Solicitud de ejemplo

Respuesta de muestra

Definiciones

LightboxOptions

WidgetMetadata

WidgetMetadataResponse

WidgetScope

WidgetSize