Compartilhar via


Dashboards - Create

Crie a dashboard fornecida.

POST 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 essa 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.

dashboardScope

DashboardScope

Entidade à qual o dashboard tem escopo.

description

string

Descrição do dashboard.

eTag

string

Valor de acompanhamento de versão definido pelo servidor, usado para editar detecção de colisão.

groupId

string

ID do grupo para um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao dashboard. Para painéis com escopo de projeto, essa propriedade está vazia.

id

string

ID do Painel. Fornecido pelo serviço no momento da criação.

lastAccessedDate

string

Data do Último Acesso do Painel.

modifiedBy

string

ID da pessoa que modificou o Painel.

modifiedDate

string

Data da última modificação do painel.

name

string

Nome do Painel.

ownerId

string

ID do proprietário de um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao dashboard. Para painéis com escopo de projeto, esse é o identificador exclusivo para a identidade do usuário associada ao dashboard.

position

integer

Posição do dashboard, dentro de um grupo dashboard. Se não for definida no momento da criação, a posição será decidida pelo serviço.

refreshInterval

integer

Intervalo para o cliente atualizar automaticamente o dashboard. Expresso em minutos.

url

string

widgets

Widget[]

O conjunto de Widgets no dashboard.

Respostas

Nome Tipo Description
200 OK

Dashboard

operação bem-sucedida

Segurança

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

Nome Description
vso.dashboards_manage Concede a capacidade de gerenciar informações de dashboard da equipe

Exemplos

Sample Request

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

{
  "name": "test",
  "position": 5,
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ]
}

Sample Response

{
  "id": "29653dd2-c18a-4d19-8333-e556c5b8d025",
  "name": "test",
  "position": 5,
  "eTag": "1",
  "widgets": [
    {
      "name": "Team Members renamed",
      "position": {
        "row": 2,
        "column": 2
      },
      "size": {
        "rowSpan": 1,
        "columnSpan": 2
      },
      "settings": null,
      "settingsVersion": {
        "major": 1,
        "minor": 0,
        "patch": 0
      },
      "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.TeamMembersWidget"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/Dashboards"
    },
    "widget": [
      {
        "href": "https://dev.azure.com/fabrikam/99755c45-cb33-4ab4-9f36-e5920cec7ba9/dc0d32d0-be95-4385-9df6-1176d698be22/_apis/Dashboard/dashboards/29653dd2-c18a-4d19-8333-e556c5b8d025/Widgets/456afb86-ecf6-49cf-bbcc-1ab7d0fc14b2"
      }
    ]
  }
}

Definições

Nome Description
Dashboard

Modelo de um Painel.

DashboardScope

Escopo do Painel. Pode ser Project ou Project_Team

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.

Widget

Dados do widget

WidgetPosition
WidgetSize

Dashboard

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 à qual o dashboard tem escopo.

description

string

Descrição do dashboard.

eTag

string

Valor de acompanhamento de versão definido pelo servidor, usado para editar detecção de colisão.

groupId

string

ID do grupo para um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao dashboard. Para painéis com escopo de projeto, essa propriedade está vazia.

id

string

ID do Painel. Fornecido pelo serviço no momento da criação.

lastAccessedDate

string

Data do Último Acesso do Painel.

modifiedBy

string

ID da pessoa que modificou o Painel.

modifiedDate

string

Data da última modificação do painel.

name

string

Nome do Painel.

ownerId

string

ID do proprietário de um dashboard. Para painéis com escopo de equipe, esse é o identificador exclusivo da equipe associada ao dashboard. Para painéis com escopo de projeto, esse é o identificador exclusivo para a identidade do usuário associada ao dashboard.

position

integer

Posição do dashboard, dentro de um grupo dashboard. Se não for definida no momento da criação, a posição será decidida pelo serviço.

refreshInterval

integer

Intervalo para o cliente atualizar automaticamente o dashboard. Expresso em minutos.

url

string

widgets

Widget[]

O conjunto de Widgets no dashboard.

DashboardScope

Escopo do Painel. Pode ser Project ou Project_Team

Nome Tipo Description
collection_User

string

[PRETERIDO] O painel tem como escopo o usuário da coleção.

project

string

O painel tem como escopo o projeto.

project_Team

string

O painel tem como escopo a equipe.

LightboxOptions

Configuração do Lightbox

Nome Tipo Description
height

integer

Altura da caixa de luz desejada, em pixels

resizable

boolean

True para permitir o redimensionamento de lightbox, false para não permitir o redimensionamento de lightbox, o padrão é false.

width

integer

Largura da caixa de luz desejada, em pixels

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

Versão principal quando você faz alterações de API incompatíveis

minor

integer

Versão secundária quando você adiciona a funcionalidade de maneira compatível com versões anteriores

patch

integer

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

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

Read-Only propriedade do Dashboard Service. Indica se as configurações estã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 do Widget fornecida.

dashboard

Dashboard

Conteúdo de dashboard parcial opcional, para dar suporte à troca de ETag de versão de nível dashboard para APIs no nível do widget

eTag

string

id

string

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

Nome Tipo Description
column

integer

row

integer

WidgetSize

Nome Tipo Description
columnSpan

integer

A Largura do widget, expressa em dashboard colunas de grade.

rowSpan

integer

A altura do widget, expressa em dashboard linhas de grade.