Dashboards - Replace Dashboards

Reference

Service:: Dashboard

API Version:: 7.1-preview.3

Aktualizujte název a umístění řídicích panelů v zadané skupině a odeberte vynechané řídicí panely. Neupravuje obsah řídicího panelu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
team	path		string	ID týmu nebo název týmu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
dashboardEntries	DashboardGroupEntry[]	Seznam řídicích panelů uložených skupinou řídicích panelů
permission	GroupMemberPermission	Zastaralé: Starý model oprávnění popisující úroveň oprávnění pro aktuální tým. Před M125.
teamDashboardPermission	TeamDashboardPermission	Bitová maska oprávnění popisující oprávnění zabezpečení aktuálního týmu pro řídicí panely. Pokud má toto oprávnění hodnotu None, použijte GroupMemberPermission. Oprávnění se vyhodnocují na základě přítomnosti jiné hodnoty než None, jinak se GroupMemberPermission uloží.
url	string

Odpovědi

Name	Typ	Description
200 OK	DashboardGroup	úspěšná operace

Zabezpečení

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	Uděluje možnost spravovat informace o týmovém řídicím panelu.

Příklady

Sample Request

HTTP

PUT https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards?api-version=7.1-preview.3

{
  "widgets": []
}

Sample Response

Status code:: 200

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

Definice

Name	Description
Dashboard	Model řídicího panelu
DashboardGroup	Popisuje seznam řídicích panelů přidružených k vlastníkovi. V současné době týmy vlastní skupiny řídicího panelu.
DashboardGroupEntry	Položka skupiny řídicího panelu, obtékání kolem řídicího panelu (vyžaduje se?)
DashboardScope	Rozsah řídicího panelu. Může to být projekt nebo Project_Team
GroupMemberPermission	Zastaralé: Starý model oprávnění popisující úroveň oprávnění pro aktuální tým. Před M125.
LightboxOptions	Konfigurace Lightboxu
ReferenceLinks	Třída představující kolekci odkazů REST.
SemanticVersion	správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.
TeamDashboardPermission	Bitová maska oprávnění popisující oprávnění zabezpečení aktuálního týmu pro řídicí panely. Pokud má toto oprávnění hodnotu None, použijte GroupMemberPermission. Oprávnění se vyhodnocují na základě přítomnosti jiné hodnoty než None, jinak se GroupMemberPermission uloží.
Widget	Data widgetu
WidgetPosition
WidgetSize

Dashboard

Model řídicího panelu

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
dashboardScope	DashboardScope	Entita, na kterou je řídicí panel vymezen.
description	string	Popis řídicího panelu.
eTag	string	Hodnota sledování verze definovaná serverem, která se používá k úpravě detekce kolizí.
groupId	string	ID skupiny pro řídicí panel U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu je tato vlastnost prázdná.
id	string	ID řídicího panelu. Služba je poskytována při vytváření.
lastAccessedDate	string	Datum posledního přístupu k řídicímu panelu.
modifiedBy	string	ID osoby, která řídicí panel upravila.
modifiedDate	string	Datum poslední změny řídicího panelu.
name	string	Název řídicího panelu.
ownerId	string	ID vlastníka řídicího panelu U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu se jedná o jedinečný identifikátor identity uživatele přidružené k řídicímu panelu.
position	integer	Umístění řídicího panelu ve skupině řídicího panelu Pokud se při vytváření nenasadí, o pozici rozhoduje služba.
refreshInterval	integer	Interval automatické aktualizace řídicího panelu klientem Vyjádřeno v minutách.
url	string
widgets	Widget[]	Sada widgetů na řídicím panelu.

DashboardGroup

Popisuje seznam řídicích panelů přidružených k vlastníkovi. V současné době týmy vlastní skupiny řídicího panelu.

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
dashboardEntries	DashboardGroupEntry[]	Seznam řídicích panelů uložených skupinou řídicích panelů
permission	GroupMemberPermission	Zastaralé: Starý model oprávnění popisující úroveň oprávnění pro aktuální tým. Před M125.
teamDashboardPermission	TeamDashboardPermission	Bitová maska oprávnění popisující oprávnění zabezpečení aktuálního týmu pro řídicí panely. Pokud má toto oprávnění hodnotu None, použijte GroupMemberPermission. Oprávnění se vyhodnocují na základě přítomnosti jiné hodnoty než None, jinak se GroupMemberPermission uloží.
url	string

DashboardGroupEntry

Položka skupiny řídicího panelu, obtékání kolem řídicího panelu (vyžaduje se?)

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
dashboardScope	DashboardScope	Entita, na kterou je řídicí panel vymezen.
description	string	Popis řídicího panelu.
eTag	string	Hodnota sledování verze definovaná serverem, která se používá k úpravě detekce kolizí.
groupId	string	ID skupiny pro řídicí panel U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu je tato vlastnost prázdná.
id	string	ID řídicího panelu. Služba je poskytována při vytváření.
lastAccessedDate	string	Datum posledního přístupu k řídicímu panelu.
modifiedBy	string	ID osoby, která řídicí panel upravila.
modifiedDate	string	Datum poslední změny řídicího panelu.
name	string	Název řídicího panelu.
ownerId	string	ID vlastníka řídicího panelu U řídicích panelů v rámci týmu se jedná o jedinečný identifikátor týmu přidruženého k řídicímu panelu. U řídicích panelů v rámci projektu se jedná o jedinečný identifikátor identity uživatele přidružené k řídicímu panelu.
position	integer	Umístění řídicího panelu ve skupině řídicího panelu Pokud se při vytváření nenasadí, o pozici rozhoduje služba.
refreshInterval	integer	Interval automatické aktualizace řídicího panelu klientem Vyjádřeno v minutách.
url	string
widgets	Widget[]	Sada widgetů na řídicím panelu.

DashboardScope

Rozsah řídicího panelu. Může to být projekt nebo Project_Team

Name	Typ	Description
collection_User	string	[ZASTARALÉ] Řídicí panel je vymezený na uživatele kolekce.
project	string	Řídicí panel je vymezený na projekt.
project_Team	string	Řídicí panel je vymezený na tým.

GroupMemberPermission

Zastaralé: Starý model oprávnění popisující úroveň oprávnění pro aktuální tým. Před M125.

Name	Typ	Description
edit	string
manage	string
managePermissions	string
none	string

LightboxOptions

Konfigurace Lightboxu

Name	Typ	Description
height	integer	Výška požadovaného lightboxu v pixelech
resizable	boolean	True pro povolení změny velikosti lightboxu, false pro zakázání změny velikosti lightboxu, výchozí hodnota je false.
width	integer	Šířka požadovaného lightboxu v pixelech

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Odkazy jsou jen pro čtení, a proto je chceme zveřejnit jen jako odkazy jen pro čtení.

SemanticVersion

správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.

Name	Typ	Description
major	integer	Hlavní verze při provádění nekompatibilních změn rozhraní API
minor	integer	Podverze při přidávání funkcí zpětně kompatibilním způsobem
patch	integer	Oprava verze při provádění zpětně kompatibilních oprav chyb

TeamDashboardPermission

Bitová maska oprávnění popisující oprávnění zabezpečení aktuálního týmu pro řídicí panely. Pokud má toto oprávnění hodnotu None, použijte GroupMemberPermission. Oprávnění se vyhodnocují na základě přítomnosti jiné hodnoty než None, jinak se GroupMemberPermission uloží.

Name	Typ	Description
create	string
delete	string
edit	string
managePermissions	string
none	string
read	string

Data widgetu

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
allowedSizes	WidgetSize[]	Odkazuje na povolené velikosti widgetu. Toto se vyplní, když chce uživatel nakonfigurovat widget.
areSettingsBlockedForUser	boolean	Read-Only vlastnost ze služby řídicího panelu. Označuje, jestli je nastavení pro aktuálního uživatele blokované.
artifactId	string	Odkazuje na jedinečný identifikátor artefaktu funkce. Používá se k připnutí a odepnutí konkrétního artefaktu.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	ID základního příspěvku definující zadanou konfiguraci widgetu.
dashboard	Dashboard	Volitelný částečný obsah řídicího panelu pro podporu výměny značky ETag na úrovni řídicího panelu pro rozhraní API na úrovni widgetů
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Konfigurace Lightboxu
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	správa verzí artefaktu, jak je popsáno na: http://semver.org/ve formátu major.minor.patch.
size	WidgetSize
typeId	string
url	string

WidgetPosition

Name	Typ	Description
column	integer
row	integer

WidgetSize

Name	Typ	Description
columnSpan	integer	Šířka widgetu vyjádřená ve sloupcích mřížky řídicího panelu
rowSpan	integer	Výška widgetu vyjádřená v řádcích mřížky řídicího panelu

Sdílet prostřednictvím