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.3Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
Identificador del panel que se va a reemplazar. |
|
organization
|
path | True |
string |
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 |
Clase que representa una colección de vínculos de referencia 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 la detección de colisiones de edición. |
| groupId |
string (uuid) |
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 (uuid) |
Id. del panel. Proporcionado por el servicio en el momento de la creación. |
| lastAccessedDate |
string (date-time) |
Fecha de último acceso al panel. |
| modifiedBy |
string (uuid) |
Identificador de la persona que modificó el panel. |
| modifiedDate |
string (date-time) |
Fecha de última modificación del panel. |
| name |
string |
Nombre del panel. |
| ownerId |
string (uuid) |
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 (int32) |
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 (int32) |
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 |
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_manage | Concede la capacidad de administrar la información del panel del equipo |
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 rest. |
|
Semantic |
control de versiones de un artefacto tal 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 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 la detección de colisiones de edición. |
| groupId |
string (uuid) |
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 (uuid) |
Id. del panel. Proporcionado por el servicio en el momento de la creación. |
| lastAccessedDate |
string (date-time) |
Fecha de último acceso al panel. |
| modifiedBy |
string (uuid) |
Identificador de la persona que modificó el panel. |
| modifiedDate |
string (date-time) |
Fecha de última modificación del panel. |
| name |
string |
Nombre del panel. |
| ownerId |
string (uuid) |
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 (int32) |
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 (int32) |
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
| Valor | Description |
|---|---|
| collection_User |
[EN DESUSO] El panel tiene como ámbito el usuario de la recopilación. |
| project |
El panel tiene como ámbito el proyecto. |
| project_Team |
El panel está en el ámbito del equipo. |
LightboxOptions
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 |
ReferenceLinks
Clase que representa una colección de vínculos de referencia 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 tal como se describe en: http://semver.org/, con el formato major.minor.patch.
| Nombre | Tipo | Description |
|---|---|---|
| major |
integer (int32) |
Versión principal al realizar cambios de API incompatibles |
| minor |
integer (int32) |
Versión secundaria al agregar funcionalidad de forma compatible con versiones anteriores |
| patch |
integer (int32) |
Revisión de la versión cuando se realizan 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 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 panel. Indica si la configuración está bloqueada para el usuario actual. |
| artifactId |
string |
Hace referencia al identificador único de un artefacto de características. 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 del widget proporcionada. |
| 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 (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Configuración de Lightbox |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
control de versiones de un artefacto tal como se describe en: http://semver.org/, con el formato major.minor.patch. |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Nombre | Tipo | Description |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| 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. |