Dashboards - Replace Dashboard
Substitua a configuração do painel especificado. Substitui a lista de Widget no Painel, somente se a propriedade for fornecida.
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
ID do painel a ser substituído. |
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
project
|
path | True |
string |
ID do projeto ou nome do projeto |
|
team
|
path |
string |
ID da equipe ou nome da equipe |
|
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar esta versão da api. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| dashboardScope |
Entidade para a qual o painel está no escopo. |
|
| description |
string |
Descrição do painel. |
| eTag |
string |
Valor de acompanhamento de versão definido pelo servidor, usado para editar a detecção de colisão. |
| groupId |
string (uuid) |
ID do grupo para um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao painel. Para painéis com escopo de projeto, essa propriedade está vazia. |
| id |
string (uuid) |
ID do Painel. Fornecido pelo serviço no momento da criação. |
| lastAccessedDate |
string (date-time) |
Data do Último Acesso do Painel. |
| modifiedBy |
string (uuid) |
ID da pessoa que modificou o Painel. |
| modifiedDate |
string (date-time) |
Data da última modificação do painel. |
| name |
string |
Nome do Painel. |
| ownerId |
string (uuid) |
ID do proprietário de um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao painel. Para painéis com escopo de projeto, esse é o identificador exclusivo para a identidade do usuário associada ao painel. |
| position |
integer (int32) |
Posição do painel, dentro de um grupo de dashboards. Se não estiver definido no momento da criação, a posição será decidida pelo serviço. |
| refreshInterval |
integer (int32) |
Intervalo para o cliente atualizar automaticamente o painel. Expresso em minutos. |
| url |
string |
|
| widgets |
Widget[] |
O conjunto de Widgets no painel. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
oauth2
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do 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
Escopos
| Nome | Description |
|---|---|
| vso.dashboards_manage | Concede a capacidade de gerenciar informações do painel de equipe |
Definições
| Nome | Description |
|---|---|
| Dashboard |
Modelo de um Painel. |
|
Dashboard |
Escopo do Painel. Pode ser Project ou Project_Team |
|
Lightbox |
Configuração do Lightbox |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Semantic |
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch. |
| Widget |
Dados do widget |
|
Widget |
|
|
Widget |
Dashboard
Modelo de um Painel.
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| dashboardScope |
Entidade para a qual o painel está no escopo. |
|
| description |
string |
Descrição do painel. |
| eTag |
string |
Valor de acompanhamento de versão definido pelo servidor, usado para editar a detecção de colisão. |
| groupId |
string (uuid) |
ID do grupo para um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao painel. Para painéis com escopo de projeto, essa propriedade está vazia. |
| id |
string (uuid) |
ID do Painel. Fornecido pelo serviço no momento da criação. |
| lastAccessedDate |
string (date-time) |
Data do Último Acesso do Painel. |
| modifiedBy |
string (uuid) |
ID da pessoa que modificou o Painel. |
| modifiedDate |
string (date-time) |
Data da última modificação do painel. |
| name |
string |
Nome do Painel. |
| ownerId |
string (uuid) |
ID do proprietário de um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao painel. Para painéis com escopo de projeto, esse é o identificador exclusivo para a identidade do usuário associada ao painel. |
| position |
integer (int32) |
Posição do painel, dentro de um grupo de dashboards. Se não estiver definido no momento da criação, a posição será decidida pelo serviço. |
| refreshInterval |
integer (int32) |
Intervalo para o cliente atualizar automaticamente o painel. Expresso em minutos. |
| url |
string |
|
| widgets |
Widget[] |
O conjunto de Widgets no painel. |
DashboardScope
Escopo do Painel. Pode ser Project ou Project_Team
| Valor | Description |
|---|---|
| collection_User |
[PRETERIDO] O painel tem como escopo o usuário da coleção. |
| project |
O painel tem o escopo do projeto. |
| project_Team |
O painel tem como escopo a equipe. |
LightboxOptions
Configuração do Lightbox
| Nome | Tipo | Description |
|---|---|---|
| height |
integer (int32) |
Altura da caixa de luz desejada, em pixels |
| resizable |
boolean |
True para permitir o redimensionamento de caixa de luz, false para não permitir o redimensionamento de caixa de luz, o padrão é false. |
| width |
integer (int32) |
Largura da caixa de luz desejada, em pixels |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
| Nome | Tipo | Description |
|---|---|---|
| links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
SemanticVersion
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch.
| Nome | Tipo | Description |
|---|---|---|
| major |
integer (int32) |
Versão principal quando você faz alterações incompatíveis na API |
| minor |
integer (int32) |
Versão secundária quando você adiciona funcionalidade de maneira compatível com versões anteriores |
| patch |
integer (int32) |
Versão do patch quando você faz correções de bug compatíveis com versões anteriores |
Widget
Dados do widget
| Nome | Tipo | Description |
|---|---|---|
| _links |
A classe para representar uma coleção de links de referência REST. |
|
| allowedSizes |
Refere-se aos tamanhos permitidos para o widget. Isso é preenchido quando o usuário deseja configurar o widget |
|
| areSettingsBlockedForUser |
boolean |
propriedade Read-Only do Serviço de Painel. Indica se as configurações são bloqueadas para o usuário atual. |
| artifactId |
string |
Refere-se ao identificador exclusivo de um artefato de recurso. Usado para fixar+desafixar um artefato específico. |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
A ID da contribuição subjacente que define a Configuração de Widget fornecida. |
| dashboard |
Conteúdo opcional do painel parcial, para dar suporte à troca de ETag de versão no nível do painel para APIs no nível do widget |
|
| eTag |
string |
|
| id |
string (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Configuração do Lightbox |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch. |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Nome | Tipo | Description |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| Nome | Tipo | Description |
|---|---|---|
| columnSpan |
integer (int32) |
A largura do widget, expressa nas colunas de grade do painel. |
| rowSpan |
integer (int32) |
A altura do widget, expressa em linhas de grade do painel. |