Dashboards - Replace Dashboards

Referência

Serviço:: Dashboard

Versão da API:: 7.1-preview.3

Atualize o nome e a posição dos painéis no grupo fornecido e remova os painéis omitidos. Não modifica o conteúdo do painel.

PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
dashboardEntries	DashboardGroupEntry[]	Uma lista de painéis mantidos pelo Grupo de Painéis
permission	GroupMemberPermission	Preterido: o modelo de permissão antigo que descreve o nível de permissões para a equipe atual. Pré-M125.
teamDashboardPermission	TeamDashboardPermission	Uma máscara de bits de permissões que descreve as permissões de segurança da equipe atual para dashboards. Quando essa permissão for o valor None, use GroupMemberPermission. As permissões são avaliadas com base na presença de um valor diferente de None, caso contrário, o GroupMemberPermission será salvo.
url	string

Respostas

Nome	Tipo	Description
200 OK	DashboardGroup	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

Exemplos

Solicitação de exemplo

HTTP

PUT https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards?api-version=7.1-preview.3

{
  "widgets": []
}

Resposta de exemplo

Código de status:: 200

{
  "widgets": [],
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/groups/999EF3B4-93E1-4086-86C2-5E8BD24512C7/Dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/Dashboard/Groups/999ef3b4-93e1-4086-86c2-5e8bd24512c7"
    }
  },
  "id": "7562562a-4f9f-4258-94a9-b048b1c817cf",
  "name": "Dashboard98",
  "position": 2,
  "refreshInterval": 5
}

Definições

Nome	Description
Dashboard	Modelo de um Painel.
DashboardGroup	Descreve uma lista de painéis associados a um proprietário. Atualmente, as equipes possuem grupos de dashboard.
DashboardGroupEntry	Entrada do grupo de painéis, encapsulando o Painel (necessário?)
DashboardScope	Escopo do Painel. Pode ser Project ou Project_Team
GroupMemberPermission	Preterido: o modelo de permissão antigo que descreve o nível de permissões para a equipe atual. Pré-M125.
LightboxOptions	Configuração do Lightbox
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
SemanticVersion	controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch.
TeamDashboardPermission	Uma máscara de bits de permissões que descreve as permissões de segurança da equipe atual para dashboards. Quando essa permissão for o valor None, use GroupMemberPermission. As permissões são avaliadas com base na presença de um valor diferente de None, caso contrário, o GroupMemberPermission será salvo.
Widget	Dados do widget
WidgetPosition
WidgetSize

Dashboard

Objeto

Modelo de um Painel.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
dashboardScope	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.

DashboardGroup

Objeto

Descreve uma lista de painéis associados a um proprietário. Atualmente, as equipes possuem grupos de dashboard.

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
dashboardEntries	DashboardGroupEntry[]	Uma lista de painéis mantidos pelo Grupo de Painéis
permission	GroupMemberPermission	Preterido: o modelo de permissão antigo que descreve o nível de permissões para a equipe atual. Pré-M125.
teamDashboardPermission	TeamDashboardPermission	Uma máscara de bits de permissões que descreve as permissões de segurança da equipe atual para dashboards. Quando essa permissão for o valor None, use GroupMemberPermission. As permissões são avaliadas com base na presença de um valor diferente de None, caso contrário, o GroupMemberPermission será salvo.
url	string

DashboardGroupEntry

Objeto

Entrada do grupo de painéis, encapsulando o Painel (necessário?)

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
dashboardScope	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

Enumeração

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.

GroupMemberPermission

Enumeração

Preterido: o modelo de permissão antigo que descreve o nível de permissões para a equipe atual. Pré-M125.

Valor	Description
edit
manage
managePermissions
none

LightboxOptions

Objeto

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

Objeto

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

Objeto

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

TeamDashboardPermission

Enumeração

Uma máscara de bits de permissões que descreve as permissões de segurança da equipe atual para dashboards. Quando essa permissão for o valor None, use GroupMemberPermission. As permissões são avaliadas com base na presença de um valor diferente de None, caso contrário, o GroupMemberPermission será salvo.

Valor	Description
create
delete
edit
managePermissions
none
read

Objeto

Dados do widget

Nome	Tipo	Description
_links	ReferenceLinks	A classe para representar uma coleção de links de referência REST.
allowedSizes	WidgetSize[]	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	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	LightboxOptions	Configuração do Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	controle de versão de um artefato, conforme descrito em: http://semver.org/, do formulário major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Objeto

Nome	Tipo	Description
column	integer (int32)
row	integer (int32)

WidgetSize

Objeto

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.

Compartilhar via

Dashboards - Replace Dashboards

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Solicitação de exemplo

Resposta de exemplo

Definições

Dashboard

DashboardGroup

DashboardGroupEntry

DashboardScope

GroupMemberPermission

LightboxOptions

ReferenceLinks

SemanticVersion

TeamDashboardPermission

Widget

WidgetPosition

WidgetSize