Compartir a través de


Dashboards - Replace Dashboard

Reemplace la configuración del panel especificado. Reemplaza la lista de widgets en el panel, solo si se proporciona la propiedad .

PUT 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
dashboardId
path True

string

uuid

Identificador del panel que se va a reemplazar.

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.

Cuerpo de la solicitud

Nombre Tipo Description
_links

ReferenceLinks

Clase que se va a representar 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.

Respuestas

Nombre Tipo Description
200 OK

Dashboard

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_manage Concede la capacidad de administrar la información del panel del equipo.

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 se va a representar una colección de vínculos de referencia de REST.

SemanticVersion

control de versiones de un artefacto tal y 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 se va a representar 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 tiene como ámbito el usuario de la colección.

project

string

El panel tiene como ámbito el proyecto.

project_Team

string

El panel tiene como ámbito el 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

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre Tipo Description
links

object

Vista de 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 tal y 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 forma 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

ReferenceLinks

Clase que se va a representar 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+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 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 tal y 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.