Dashboards - Replace Dashboard

Service:

Dashboard

API Version:

4.1-preview.2

Belirtilen panonun yapılandırmasını değiştirin.

HTTP

PUT https://{instance}/{collection}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=4.1-preview.2

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
collection	path	True	string	Team Foundation Server koleksiyonunun adı.
dashboardId	path	True	string uuid	Değiştirilmeye değer panonun kimliği.
instance	path	True	string	TFS sunucu adı ({server:port})
project	path	True	string	Proje Kimliği veya proje adı
team	path		string	Ekip kimliği veya ekip adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '4.1-preview.2' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
description	string	Panonun açıklaması.
eTag	string	Çakışma algılamayı düzenlemek için kullanılan sunucu tanımlı sürüm izleme değeri.
id	string	Panonun kimliği. Oluşturma zamanında hizmet tarafından sağlanır.
name	string	Panonun adı.
ownerId	string	Panonun Sahibi kimliği. Eski panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısı olacaktır.
position	integer	Pano grubunun içindeki panonun konumu. Oluşturma zamanında ayarlanmazsa, konum hizmet tarafından belirlenir.
refreshInterval	integer	İstemcinin panoyu otomatik olarak yenileme aralığı. Dakikalar içinde ifade edilir.
url	string
widgets	Widget[]	Panodaki Pencere Öğeleri kümesi.

Yanıtlar

Name	Tür	Description
200 OK	Dashboard	başarılı işlem

Güvenlik

accessToken

Kişisel erişim belirteci. Parola olarak kullanıcı adı ve belirteç için herhangi bir değer kullanın.

Type: basic

Tanımlar

Name	Description
Dashboard	Pano modeli.
LightboxOptions	Lightbox yapılandırması
ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
SemanticVersion	bir yapıtın sürüm oluşturma işleminin major.minor.patch biçimindeki şu http://semver.org/konumda açıklandığı gibi olması gerekir.
Widget	Pencere öğesi verileri
WidgetPosition
WidgetSize

Dashboard

Pano modeli.

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
description	string	Panonun açıklaması.
eTag	string	Çakışma algılamayı düzenlemek için kullanılan sunucu tanımlı sürüm izleme değeri.
id	string	Panonun kimliği. Oluşturma zamanında hizmet tarafından sağlanır.
name	string	Panonun adı.
ownerId	string	Panonun Sahibi kimliği. Eski panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısı olacaktır.
position	integer	Pano grubunun içindeki panonun konumu. Oluşturma zamanında ayarlanmazsa, konum hizmet tarafından belirlenir.
refreshInterval	integer	İstemcinin panoyu otomatik olarak yenileme aralığı. Dakikalar içinde ifade edilir.
url	string
widgets	Widget[]	Panodaki Pencere Öğeleri kümesi.

LightboxOptions

Lightbox yapılandırması

Name	Tür	Description
height	integer	İstenen ışık kutusunun piksel cinsinden yüksekliği
resizable	boolean	Lightbox yeniden boyutlandırmasına izin vermek için True, lightbox yeniden boyutlandırmasını reddetmek için false, varsayılan olarak false olarak ayarlanır.
width	integer	İstenen ışık kutusunun piksel cinsinden genişliği

ReferenceLinks

REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

SemanticVersion

bir yapıtın sürüm oluşturma işleminin major.minor.patch biçimindeki şu http://semver.org/konumda açıklandığı gibi olması gerekir.

Name	Tür	Description
major	integer	Uyumsuz API değişiklikleri yaptığınızda ana sürüm
minor	integer	İşlevleri geriye dönük uyumlu bir şekilde eklediğinizde ikincil sürüm
patch	integer	Geriye dönük uyumlu hata düzeltmeleri yaptığınızda sürüme düzeltme eki uygulama

Widget

Pencere öğesi verileri

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
allowedSizes	WidgetSize[]	Pencere öğesi için izin verilen boyutları ifade eder. Kullanıcı pencere öğesini yapılandırmak istediğinde bu doldurulur
areSettingsBlockedForUser	boolean	Pano Hizmeti'nden Read-Only Özelliği. Ayarların geçerli kullanıcı için engellenip engellenmediğini gösterir.
artifactId	string	Özellik yapıtının benzersiz tanımlayıcısına başvurur. Belirli bir yapıtı sabitlemek+sabitlemeyi kaldırma için kullanılır.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	Sağlanan Pencere Öğesi Yapılandırmasını tanımlayan temel katkının kimliği.
dashboard	Dashboard	Pencere öğesi düzeyinde API'ler için pano düzeyinde ETag alışverişi desteklemeye yönelik isteğe bağlı kısmi pano içeriği
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Lightbox yapılandırması
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	bir yapıtın sürüm oluşturma işleminin major.minor.patch biçimindeki şu http://semver.org/konumda açıklandığı gibi olması gerekir.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Name	Tür	Description
column	integer
row	integer

WidgetSize

Name	Tür	Description
columnSpan	integer	Pano kılavuzu sütunlarında ifade edilen pencere öğesinin Genişliği.
rowSpan	integer	Pano kılavuzu satırlarında ifade edilen pencere öğesinin yüksekliği.