Dashboards - Replace Dashboard
Zastąp konfigurację określonego pulpitu nawigacyjnego. Zamienia listę widżetów na pulpicie nawigacyjnym tylko wtedy, gdy podano właściwość.
PUT https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
dashboard
|
path | True |
string (uuid) |
Identyfikator pulpitu nawigacyjnego do zastąpienia. |
|
organization
|
path | True |
string |
Nazwa organizacji usługi Azure DevOps. |
|
project
|
path | True |
string |
Identyfikator projektu lub nazwa projektu |
|
team
|
path |
string |
Identyfikator zespołu lub nazwa zespołu |
|
|
api-version
|
query | True |
string |
Wersja interfejsu API do użycia. Należy ustawić wartość "7.1-preview.3", aby używać tej wersji interfejsu API. |
Treść żądania
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
| dashboardScope |
Jednostka, do której jest zakres pulpitu nawigacyjnego. |
|
| description |
string |
Opis pulpitu nawigacyjnego. |
| eTag |
string |
Wartość śledzenia wersji zdefiniowana przez serwer używana do wykrywania kolizji edycji. |
| groupId |
string (uuid) |
Identyfikator grupy dla pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych w zakresie projektu ta właściwość jest pusta. |
| id |
string (uuid) |
Identyfikator pulpitu nawigacyjnego. Udostępniane przez usługę w czasie tworzenia. |
| lastAccessedDate |
string (date-time) |
Data ostatniego dostępu do pulpitu nawigacyjnego. |
| modifiedBy |
string (uuid) |
Identyfikator osoby, która zmodyfikowała pulpit nawigacyjny. |
| modifiedDate |
string (date-time) |
Data ostatniej modyfikacji pulpitu nawigacyjnego. |
| name |
string |
Nazwa pulpitu nawigacyjnego. |
| ownerId |
string (uuid) |
Identyfikator właściciela pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych o zakresie projektu jest to unikatowy identyfikator tożsamości użytkownika skojarzonej z pulpitem nawigacyjnym. |
| position |
integer (int32) |
Pozycja pulpitu nawigacyjnego w grupie pulpitów nawigacyjnych. Jeśli pozycja nie zostanie zdenerwowana w czasie tworzenia, zostanie podjęta przez usługę. |
| refreshInterval |
integer (int32) |
Interwał odświeżania pulpitu nawigacyjnego przez klienta. Wyrażone w minutach. |
| url |
string |
|
| widgets |
Widget[] |
Zestaw widżetów na pulpicie nawigacyjnym. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
operacja zakończona powodzeniem |
Zabezpieczenia
oauth2
Typ:
oauth2
Flow:
accessCode
Adres URL autoryzacji:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu:
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
Zakresy
| Nazwa | Opis |
|---|---|
| vso.dashboards_manage | Przyznaje możliwość zarządzania informacjami o pulpicie nawigacyjnym zespołu |
Definicje
| Nazwa | Opis |
|---|---|
| Dashboard |
Model pulpitu nawigacyjnego. |
|
Dashboard |
Zakres pulpitu nawigacyjnego. Może to być projekt lub Project_Team |
|
Lightbox |
Konfiguracja lightbox |
|
Reference |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
Semantic |
przechowywanie wersji artefaktu zgodnie z opisem: http://semver.org/, formularza major.minor.patch. |
| Widget |
Dane widżetu |
|
Widget |
|
|
Widget |
Dashboard
Model pulpitu nawigacyjnego.
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
| dashboardScope |
Jednostka, do której jest zakres pulpitu nawigacyjnego. |
|
| description |
string |
Opis pulpitu nawigacyjnego. |
| eTag |
string |
Wartość śledzenia wersji zdefiniowana przez serwer używana do wykrywania kolizji edycji. |
| groupId |
string (uuid) |
Identyfikator grupy dla pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych w zakresie projektu ta właściwość jest pusta. |
| id |
string (uuid) |
Identyfikator pulpitu nawigacyjnego. Udostępniane przez usługę w czasie tworzenia. |
| lastAccessedDate |
string (date-time) |
Data ostatniego dostępu do pulpitu nawigacyjnego. |
| modifiedBy |
string (uuid) |
Identyfikator osoby, która zmodyfikowała pulpit nawigacyjny. |
| modifiedDate |
string (date-time) |
Data ostatniej modyfikacji pulpitu nawigacyjnego. |
| name |
string |
Nazwa pulpitu nawigacyjnego. |
| ownerId |
string (uuid) |
Identyfikator właściciela pulpitu nawigacyjnego. W przypadku pulpitów nawigacyjnych o zakresie zespołu jest to unikatowy identyfikator zespołu skojarzonego z pulpitem nawigacyjnym. W przypadku pulpitów nawigacyjnych o zakresie projektu jest to unikatowy identyfikator tożsamości użytkownika skojarzonej z pulpitem nawigacyjnym. |
| position |
integer (int32) |
Pozycja pulpitu nawigacyjnego w grupie pulpitów nawigacyjnych. Jeśli pozycja nie zostanie zdenerwowana w czasie tworzenia, zostanie podjęta przez usługę. |
| refreshInterval |
integer (int32) |
Interwał odświeżania pulpitu nawigacyjnego przez klienta. Wyrażone w minutach. |
| url |
string |
|
| widgets |
Widget[] |
Zestaw widżetów na pulpicie nawigacyjnym. |
DashboardScope
Zakres pulpitu nawigacyjnego. Może to być projekt lub Project_Team
| Wartość | Opis |
|---|---|
| collection_User |
[PRZESTARZAŁE] Pulpit nawigacyjny jest w zakresie użytkownika kolekcji. |
| project |
Pulpit nawigacyjny jest w zakresie projektu. |
| project_Team |
Pulpit nawigacyjny jest zakresem zespołu. |
LightboxOptions
Konfiguracja lightbox
| Nazwa | Typ | Opis |
|---|---|---|
| height |
integer (int32) |
Wysokość żądanego światła w pikselach |
| resizable |
boolean |
Wartość True zezwala na zmianę rozmiaru lightbox, fałsz, aby nie zezwalać na zmianę rozmiaru lightbox, domyślnie ma wartość false. |
| width |
integer (int32) |
Szerokość żądanego światła w pikselach |
ReferenceLinks
Klasa reprezentująca kolekcję linków referencyjnych REST.
| Nazwa | Typ | Opis |
|---|---|---|
| links |
object |
Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu. |
SemanticVersion
przechowywanie wersji artefaktu zgodnie z opisem: http://semver.org/, formularza major.minor.patch.
| Nazwa | Typ | Opis |
|---|---|---|
| major |
integer (int32) |
Wersja główna po wprowadzeniu niezgodnych zmian interfejsu API |
| minor |
integer (int32) |
Wersja pomocnicza podczas dodawania funkcji w sposób zgodny z poprzednimi wersjami |
| patch |
integer (int32) |
Wersja poprawek w przypadku wprowadzania poprawek usterek zgodnych z poprzednimi wersjami |
Widget
Dane widżetu
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
| allowedSizes |
Odwołuje się do dozwolonych rozmiarów widżetu. Spowoduje to wypełnienie, gdy użytkownik chce skonfigurować widżet |
|
| areSettingsBlockedForUser |
boolean |
Read-Only właściwość z usługi pulpitu nawigacyjnego. Wskazuje, czy ustawienia są blokowane dla bieżącego użytkownika. |
| artifactId |
string |
Odwołuje się do unikatowego identyfikatora artefaktu funkcji. Służy do przypinania+odłączania określonego artefaktu. |
| configurationContributionId |
string |
|
| configurationContributionRelativeId |
string |
|
| contentUri |
string |
|
| contributionId |
string |
Identyfikator bazowego współtworzenia definiującego podaną konfigurację widżetu. |
| dashboard |
Opcjonalna częściowa zawartość pulpitu nawigacyjnego do obsługi wymiany wersji na poziomie pulpitu nawigacyjnego ETag dla interfejsów API na poziomie widżetu |
|
| eTag |
string |
|
| id |
string (uuid) |
|
| isEnabled |
boolean |
|
| isNameConfigurable |
boolean |
|
| lightboxOptions |
Konfiguracja lightbox |
|
| loadingImageUrl |
string |
|
| name |
string |
|
| position | ||
| settings |
string |
|
| settingsVersion |
przechowywanie wersji artefaktu zgodnie z opisem: http://semver.org/, formularza major.minor.patch. |
|
| size | ||
| typeId |
string |
|
| url |
string |
WidgetPosition
| Nazwa | Typ | Opis |
|---|---|---|
| column |
integer (int32) |
|
| row |
integer (int32) |
WidgetSize
| Nazwa | Typ | Opis |
|---|---|---|
| columnSpan |
integer (int32) |
Szerokość widżetu wyrażona w kolumnach siatki pulpitu nawigacyjnego. |
| rowSpan |
integer (int32) |
Wysokość widżetu wyrażona w wierszach siatki pulpitu nawigacyjnego. |