Dashboards - Replace Dashboard

Referensi

Service:: Dashboard

API Version:: 7.1-preview.3

Ganti konfigurasi untuk dasbor yang ditentukan. Menggantikan daftar Widget di Dasbor, hanya jika properti disediakan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
dashboardId	path	True	string uuid	ID dasbor untuk diganti.
organization	path	True	string	Nama organisasi Azure DevOps.
project	path	True	string	ID proyek atau nama proyek
team	path		string	ID tim atau nama tim
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.3' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
dashboardScope	DashboardScope	Entitas tempat dasbor dilingkup.
description	string	Deskripsi dasbor.
eTag	string	Nilai pelacakan versi yang ditentukan server, digunakan untuk mengedit deteksi tabrakan.
groupId	string	ID grup untuk dasbor. Untuk dasbor cakupan tim, ini adalah pengidentifikasi unik untuk tim yang terkait dengan dasbor. Untuk dasbor yang dilingkup proyek, properti ini kosong.
id	string	ID Dasbor. Disediakan oleh layanan pada waktu pembuatan.
lastAccessedDate	string	Dasbor Tanggal Terakhir Diakses.
modifiedBy	string	Id orang yang mengubah Dasbor.
modifiedDate	string	Tanggal terakhir dimodifikasi dasbor.
name	string	Nama Dasbor.
ownerId	string	ID pemilik untuk dasbor. Untuk dasbor cakupan tim, ini adalah pengidentifikasi unik untuk tim yang terkait dengan dasbor. Untuk dasbor cakupan proyek, ini adalah pengidentifikasi unik untuk identitas pengguna yang terkait dengan dasbor.
position	integer	Posisi dasbor, dalam grup dasbor. Jika tidak diatur pada waktu pembuatan, posisi diputuskan oleh layanan.
refreshInterval	integer	Interval bagi klien untuk me-refresh dasbor secara otomatis. Dinyatakan dalam beberapa menit.
url	string
widgets	Widget[]	Kumpulan Widget di dasbor.

Respons

Nama	Jenis	Deskripsi
200 OK	Dashboard	operasi berhasil

Keamanan

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

Nama	Deskripsi
vso.dashboards_manage	Memberikan kemampuan untuk mengelola informasi dasbor tim

Definisi

Nama	Deskripsi
Dashboard	Model Dasbor.
DashboardScope	Cakupan Dasbor. Dapat berupa Project atau Project_Team
LightboxOptions	Konfigurasi Lightbox
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
SemanticVersion	penerapan versi untuk artefak seperti yang dijelaskan di: http://semver.org/, dari bentuk major.minor.patch.
Widget	Data widget
WidgetPosition
WidgetSize

Dashboard

Model Dasbor.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
dashboardScope	DashboardScope	Entitas tempat dasbor dilingkup.
description	string	Deskripsi dasbor.
eTag	string	Nilai pelacakan versi yang ditentukan server, digunakan untuk mengedit deteksi tabrakan.
groupId	string	ID grup untuk dasbor. Untuk dasbor cakupan tim, ini adalah pengidentifikasi unik untuk tim yang terkait dengan dasbor. Untuk dasbor yang dilingkup proyek, properti ini kosong.
id	string	ID Dasbor. Disediakan oleh layanan pada waktu pembuatan.
lastAccessedDate	string	Dasbor Tanggal Terakhir Diakses.
modifiedBy	string	Id orang yang mengubah Dasbor.
modifiedDate	string	Tanggal terakhir dimodifikasi dasbor.
name	string	Nama Dasbor.
ownerId	string	ID pemilik untuk dasbor. Untuk dasbor cakupan tim, ini adalah pengidentifikasi unik untuk tim yang terkait dengan dasbor. Untuk dasbor cakupan proyek, ini adalah pengidentifikasi unik untuk identitas pengguna yang terkait dengan dasbor.
position	integer	Posisi dasbor, dalam grup dasbor. Jika tidak diatur pada waktu pembuatan, posisi diputuskan oleh layanan.
refreshInterval	integer	Interval bagi klien untuk me-refresh dasbor secara otomatis. Dinyatakan dalam beberapa menit.
url	string
widgets	Widget[]	Kumpulan Widget di dasbor.

DashboardScope

Cakupan Dasbor. Dapat berupa Project atau Project_Team

Nama	Jenis	Deskripsi
collection_User	string	[TIDAK DIGUNAKAN LAGI] Dasbor dilingkupkan ke pengguna koleksi.
project	string	Dasbor dilingkup ke proyek.
project_Team	string	Dasbor dilingkupkan ke tim.

LightboxOptions

Konfigurasi Lightbox

Nama	Jenis	Deskripsi
height	integer	Tinggi lightbox yang diinginkan, dalam piksel
resizable	boolean	True untuk memungkinkan pengurangan ukuran lightbox, false untuk melarang perubahan ukuran lightbox, default ke false.
width	integer	Lebar kotak cahaya yang diinginkan, dalam piksel

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja.

SemanticVersion

penerapan versi untuk artefak seperti yang dijelaskan di: http://semver.org/, dari bentuk major.minor.patch.

Nama	Jenis	Deskripsi
major	integer	Versi utama saat Anda membuat perubahan API yang tidak kompatibel
minor	integer	Versi minor saat Anda menambahkan fungsionalitas dengan cara yang kompatibel mundur
patch	integer	Versi patch saat Anda melakukan perbaikan bug yang kompatibel dengan versi mundur

Data widget

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
allowedSizes	WidgetSize[]	Mengacu pada ukuran yang diizinkan untuk widget. Ini akan diisi ketika pengguna ingin mengonfigurasi widget
areSettingsBlockedForUser	boolean	Read-Only Properti dari Layanan Dasbor. Menunjukkan apakah pengaturan diblokir untuk pengguna saat ini.
artifactId	string	Mengacu pada pengidentifikasi unik artefak fitur. Digunakan untuk menyematkan+melepas semat artefak tertentu.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	Id kontribusi yang mendasar yang menentukan Konfigurasi Widget yang disediakan.
dashboard	Dashboard	Konten dasbor parsial opsional, untuk mendukung pertukaran ETag versi tingkat dasbor untuk API tingkat widget
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Konfigurasi Lightbox
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	penerapan versi untuk artefak seperti yang dijelaskan di: http://semver.org/, dari bentuk major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Nama	Jenis	Deskripsi
column	integer
row	integer

WidgetSize

Nama	Jenis	Deskripsi
columnSpan	integer	Lebar widget, yang dinyatakan dalam kolom kisi dasbor.
rowSpan	integer	Tinggi widget, dinyatakan dalam baris kisi dasbor.

Bagikan melalui