Dashboards - Create

Başvuru

Service:: Dashboard

API Version:: 7.1-preview.3

Sağlanan panoyu oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
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 sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.3' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
dashboardScope	DashboardScope	Panonun kapsamı belirlenmiş varlık.
description	string	Panonun açıklaması.
eTag	string	Düzenleme çakışması algılaması için kullanılan sunucu tanımlı sürüm izleme değeri.
groupId	string	Pano için grubun kimliği. Ekip kapsamlı panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısıdır. Proje kapsamlı panolar için bu özellik boş.
id	string	Panonun kimliği. Oluşturma zamanında hizmet tarafından sağlanır.
lastAccessedDate	string	Panoya Son Erişim Tarihi.
modifiedBy	string	Pano'yu değiştiren kişinin kimliği.
modifiedDate	string	Panonun son değiştirme tarihi.
name	string	Panonun adı.
ownerId	string	Pano sahibinin kimliği. Ekip kapsamlı panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısıdır. Proje kapsamlı panolar için bu, panoyla ilişkilendirilmiş kullanıcı kimliğinin benzersiz tanımlayıcısıdır.
position	integer	Panonun bir pano grubu içindeki konumu. Oluşturma zamanında ayarlanmazsa, konum hizmet tarafından belirlenir.
refreshInterval	integer	İstemcinin panoyu otomatik olarak yenileme aralığı. Dakika cinsinden 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

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

Name	Description
vso.dashboards_manage	Ekip panosu bilgilerini yönetme olanağı sağlar

Örnekler

Sample Request

HTTP

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

Status code:: 200

{
  "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"
      }
    ]
  }
}

Tanımlar

Name	Description
Dashboard	Pano modeli.
DashboardScope	Pano Kapsamı. Project veya Project_Team olabilir
LightboxOptions	Lightbox yapılandırması
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
SemanticVersion	major.minor.patch formunun: http://semver.org/adresinde açıklandığı gibi bir yapıt için sürüm oluşturma.
Widget	Pencere öğesi verileri
WidgetPosition
WidgetSize

Dashboard

Pano modeli.

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
dashboardScope	DashboardScope	Panonun kapsamı belirlenmiş varlık.
description	string	Panonun açıklaması.
eTag	string	Düzenleme çakışması algılaması için kullanılan sunucu tanımlı sürüm izleme değeri.
groupId	string	Pano için grubun kimliği. Ekip kapsamlı panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısıdır. Proje kapsamlı panolar için bu özellik boş.
id	string	Panonun kimliği. Oluşturma zamanında hizmet tarafından sağlanır.
lastAccessedDate	string	Panoya Son Erişim Tarihi.
modifiedBy	string	Pano'yu değiştiren kişinin kimliği.
modifiedDate	string	Panonun son değiştirme tarihi.
name	string	Panonun adı.
ownerId	string	Pano sahibinin kimliği. Ekip kapsamlı panolar için bu, panoyla ilişkilendirilmiş ekibin benzersiz tanımlayıcısıdır. Proje kapsamlı panolar için bu, panoyla ilişkilendirilmiş kullanıcı kimliğinin benzersiz tanımlayıcısıdır.
position	integer	Panonun bir pano grubu içindeki konumu. Oluşturma zamanında ayarlanmazsa, konum hizmet tarafından belirlenir.
refreshInterval	integer	İstemcinin panoyu otomatik olarak yenileme aralığı. Dakika cinsinden ifade edilir.
url	string
widgets	Widget[]	Panodaki Pencere Öğeleri kümesi.

DashboardScope

Pano Kapsamı. Project veya Project_Team olabilir

Name	Tür	Description
collection_User	string	[KULLANIM DIŞI] Panonun kapsamı koleksiyon kullanıcısı olarak belirlenmiştir.
project	string	Panonun kapsamı proje kapsamındadır.
project_Team	string	Panonun kapsamı ekip tarafından belirlenmiştir.

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'ın yeniden boyutlandırılmasına izin vermek 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ı 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 göstermek istiyoruz.

SemanticVersion

major.minor.patch formunun: http://semver.org/adresinde açıklandığı gibi bir yapıt için sürüm oluşturma.

Name	Tür	Description
major	integer	Uyumsuz API değişiklikleri yaptığınızda ana sürüm
minor	integer	İşlevselliği 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 düzeltme eki sürümü

Pencere öğesi verileri

Name	Tür	Description
_links	ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
allowedSizes	WidgetSize[]	Pencere öğesi için izin verilen boyutları ifade eder. Bu, kullanıcı pencere öğesini yapılandırmak istediğinde doldurulur
areSettingsBlockedForUser	boolean	Pano Hizmeti'nden Read-Only Özelliği. Geçerli kullanıcı için ayarların 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+sabitlemek 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 desteklemek üzere 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	major.minor.patch formunun: http://semver.org/adresinde açıklandığı gibi bir yapıt için sürüm oluşturma.
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.

Aracılığıyla paylaş