Dashboards - Replace Dashboards
Perbarui nama dan posisi dasbor dalam grup yang disediakan, dan hapus dasbor yang dihilangkan. Tidak mengubah konten dasbor.
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards?api-version=7.1-preview.3
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
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 |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
dashboardEntries |
Daftar Dasbor yang dipegang oleh Grup Dasbor |
|
permission |
Tidak digunakan lagi: Model izin lama yang menjelaskan tingkat izin untuk tim saat ini. Pra-M125. |
|
teamDashboardPermission |
Masker bit izin yang menjelaskan izin keamanan tim saat ini untuk dasbor. Ketika izin ini adalah nilai Tidak Ada, gunakan GroupMemberPermission. Izin dievaluasi berdasarkan keberadaan nilai selain Tidak Ada, jika tidak, GroupMemberPermission akan disimpan. |
|
url |
string |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
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 |
Contoh
Sample Request
PUT https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards?api-version=7.1-preview.3
{
"widgets": []
}
Sample Response
{
"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
}
Definisi
Nama | Deskripsi |
---|---|
Dashboard |
Model Dasbor. |
Dashboard |
Menjelaskan daftar dasbor yang terkait dengan pemilik. Saat ini, tim memiliki grup dasbor. |
Dashboard |
Entri grup dasbor, membungkus dasbor (diperlukan?) |
Dashboard |
Cakupan Dasbor. Dapat berupa Project atau Project_Team |
Group |
Tidak digunakan lagi: Model izin lama yang menjelaskan tingkat izin untuk tim saat ini. Pra-M125. |
Lightbox |
Konfigurasi lightbox |
Reference |
Kelas untuk mewakili kumpulan tautan referensi REST. |
Semantic |
penerapan versi untuk artefak seperti yang dijelaskan di: http://semver.org/, dari bentuk major.minor.patch. |
Team |
Masker bit izin yang menjelaskan izin keamanan tim saat ini untuk dasbor. Ketika izin ini adalah nilai Tidak Ada, gunakan GroupMemberPermission. Izin dievaluasi berdasarkan keberadaan nilai selain Tidak Ada, jika tidak, GroupMemberPermission akan disimpan. |
Widget |
Data widget |
Widget |
|
Widget |
Dashboard
Model Dasbor.
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
dashboardScope |
Entitas tempat dasbor dilingkupkan. |
|
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 cakupan proyek, properti ini kosong. |
id |
string |
ID Dasbor. Disediakan oleh layanan pada waktu pembuatan. |
lastAccessedDate |
string |
Tanggal Akses Terakhir Dasbor. |
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. |
DashboardGroup
Menjelaskan daftar dasbor yang terkait dengan pemilik. Saat ini, tim memiliki grup dasbor.
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
dashboardEntries |
Daftar Dasbor yang dipegang oleh Grup Dasbor |
|
permission |
Tidak digunakan lagi: Model izin lama yang menjelaskan tingkat izin untuk tim saat ini. Pra-M125. |
|
teamDashboardPermission |
Masker bit izin yang menjelaskan izin keamanan tim saat ini untuk dasbor. Ketika izin ini adalah nilai Tidak Ada, gunakan GroupMemberPermission. Izin dievaluasi berdasarkan keberadaan nilai selain Tidak Ada, jika tidak, GroupMemberPermission akan disimpan. |
|
url |
string |
DashboardGroupEntry
Entri grup dasbor, membungkus dasbor (diperlukan?)
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
dashboardScope |
Entitas tempat dasbor dilingkupkan. |
|
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 cakupan proyek, properti ini kosong. |
id |
string |
ID Dasbor. Disediakan oleh layanan pada waktu pembuatan. |
lastAccessedDate |
string |
Tanggal Akses Terakhir Dasbor. |
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. |
GroupMemberPermission
Tidak digunakan lagi: Model izin lama yang menjelaskan tingkat izin untuk tim saat ini. Pra-M125.
Nama | Jenis | Deskripsi |
---|---|---|
edit |
string |
|
manage |
string |
|
managePermissions |
string |
|
none |
string |
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 |
TeamDashboardPermission
Masker bit izin yang menjelaskan izin keamanan tim saat ini untuk dasbor. Ketika izin ini adalah nilai Tidak Ada, gunakan GroupMemberPermission. Izin dievaluasi berdasarkan keberadaan nilai selain Tidak Ada, jika tidak, GroupMemberPermission akan disimpan.
Nama | Jenis | Deskripsi |
---|---|---|
create |
string |
|
delete |
string |
|
edit |
string |
|
managePermissions |
string |
|
none |
string |
|
read |
string |
Widget
Data widget
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
allowedSizes |
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 |
Konten dasbor parsial opsional, untuk mendukung pertukaran ETag versi tingkat dasbor untuk API tingkat widget |
|
eTag |
string |
|
id |
string |
|
isEnabled |
boolean |
|
isNameConfigurable |
boolean |
|
lightboxOptions |
Konfigurasi lightbox |
|
loadingImageUrl |
string |
|
name |
string |
|
position | ||
settings |
string |
|
settingsVersion |
penerapan versi untuk artefak seperti yang dijelaskan di: http://semver.org/, dari bentuk major.minor.patch. |
|
size | ||
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. |