Dashboards - Replace Dashboards

참조

서비스:: Dashboard

API 버전:: 7.1-preview.3

제공된 그룹에서 대시보드의 이름과 위치를 업데이트하고 생략된 대시보드를 제거합니다. 대시보드 콘텐츠를 수정하지 않습니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path	True	string	프로젝트 ID 또는 프로젝트 이름
team	path		string	팀 ID 또는 팀 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1-preview.3'으로 설정해야 합니다.

요청 본문

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
dashboardEntries	DashboardGroupEntry[]	대시보드 그룹이 보유한 대시보드 목록
permission	GroupMemberPermission	사용되지 않음: 현재 팀의 사용 권한 수준을 설명하는 이전 사용 권한 모델입니다. 사전 M125.
teamDashboardPermission	TeamDashboardPermission	대시보드에 대한 현재 팀의 보안 권한을 설명하는 권한 비트 마스크입니다. 이 권한이 None 값이면 GroupMemberPermission을 사용합니다. 사용 권한은 None 이외의 값이 있는 경우를 기준으로 평가되며, 그렇지 않으면 GroupMemberPermission이 저장됩니다.
url	string

응답

Name	형식	Description
200 OK	DashboardGroup	성공한 작업

보안

oauth2

형식: oauth2
Flow: accessCode
권한 부여 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
토큰 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

범위

Name	Description
vso.dashboards_manage	팀 대시보드 정보를 관리하는 기능을 부여합니다.

예제

샘플 요청

HTTP

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

{
  "widgets": []
}

샘플 응답

상태 코드:: 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
}

정의

Name	Description
Dashboard	대시보드의 모델입니다.
DashboardGroup	소유자와 연결된 대시보드의 목록을 설명합니다. 현재 팀은 대시보드 그룹을 소유하고 있습니다.
DashboardGroupEntry	대시보드 그룹 항목, 대시보드 주위에 래핑(필요한가요?)
DashboardScope	대시보드 범위입니다. Project 또는 Project_Team
GroupMemberPermission	사용되지 않음: 현재 팀의 사용 권한 수준을 설명하는 이전 사용 권한 모델입니다. 사전 M125.
LightboxOptions	Lightbox 구성
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
SemanticVersion	에 설명된 대로 아티팩트 버전 관리: http://semver.org/( major.minor.patch)
TeamDashboardPermission	대시보드에 대한 현재 팀의 보안 권한을 설명하는 권한 비트 마스크입니다. 이 권한이 None 값이면 GroupMemberPermission을 사용합니다. 사용 권한은 None 이외의 값이 있는 경우를 기준으로 평가되며, 그렇지 않으면 GroupMemberPermission이 저장됩니다.
Widget	위젯 데이터
WidgetPosition
WidgetSize

Dashboard

Object

대시보드의 모델입니다.

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
dashboardScope	DashboardScope	대시보드의 범위가 지정된 엔터티입니다.
description	string	대시보드에 대한 설명입니다.
eTag	string	충돌 검색 편집에 사용되는 서버 정의 버전 추적 값입니다.
groupId	string (uuid)	대시보드에 대한 그룹의 ID입니다. 팀 범위 대시보드의 경우 대시보드와 연결된 팀의 고유 식별자입니다. 프로젝트 범위 대시보드의 경우 이 속성은 비어 있습니다.
id	string (uuid)	대시보드의 ID입니다. 생성 시 서비스에서 제공합니다.
lastAccessedDate	string (date-time)	대시보드 마지막으로 액세스한 날짜입니다.
modifiedBy	string (uuid)	대시보드를 수정한 사용자의 ID입니다.
modifiedDate	string (date-time)	대시보드의 마지막 수정 날짜입니다.
name	string	대시보드의 이름입니다.
ownerId	string (uuid)	대시보드의 소유자 ID입니다. 팀 범위 대시보드의 경우 대시보드와 연결된 팀의 고유 식별자입니다. 프로젝트 범위 대시보드의 경우 대시보드와 연결된 사용자 ID의 고유 식별자입니다.
position	integer (int32)	대시보드 그룹 내 대시보드의 위치입니다. 생성 시 설정되지 않은 경우 서비스에서 위치를 결정합니다.
refreshInterval	integer (int32)	클라이언트가 대시보드를 자동으로 새로 고치는 간격입니다. 분 단위로 표현됩니다.
url	string
widgets	Widget[]	대시보드의 위젯 집합입니다.

DashboardGroup

Object

소유자와 연결된 대시보드의 목록을 설명합니다. 현재 팀은 대시보드 그룹을 소유하고 있습니다.

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
dashboardEntries	DashboardGroupEntry[]	대시보드 그룹이 보유한 대시보드 목록
permission	GroupMemberPermission	사용되지 않음: 현재 팀의 사용 권한 수준을 설명하는 이전 사용 권한 모델입니다. 사전 M125.
teamDashboardPermission	TeamDashboardPermission	대시보드에 대한 현재 팀의 보안 권한을 설명하는 권한 비트 마스크입니다. 이 권한이 None 값이면 GroupMemberPermission을 사용합니다. 사용 권한은 None 이외의 값이 있는 경우를 기준으로 평가되며, 그렇지 않으면 GroupMemberPermission이 저장됩니다.
url	string

DashboardGroupEntry

Object

대시보드 그룹 항목, 대시보드 주위에 래핑(필요한가요?)

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
dashboardScope	DashboardScope	대시보드의 범위가 지정된 엔터티입니다.
description	string	대시보드에 대한 설명입니다.
eTag	string	충돌 검색 편집에 사용되는 서버 정의 버전 추적 값입니다.
groupId	string (uuid)	대시보드에 대한 그룹의 ID입니다. 팀 범위 대시보드의 경우 대시보드와 연결된 팀의 고유 식별자입니다. 프로젝트 범위 대시보드의 경우 이 속성은 비어 있습니다.
id	string (uuid)	대시보드의 ID입니다. 생성 시 서비스에서 제공합니다.
lastAccessedDate	string (date-time)	대시보드 마지막으로 액세스한 날짜입니다.
modifiedBy	string (uuid)	대시보드를 수정한 사용자의 ID입니다.
modifiedDate	string (date-time)	대시보드의 마지막 수정 날짜입니다.
name	string	대시보드의 이름입니다.
ownerId	string (uuid)	대시보드의 소유자 ID입니다. 팀 범위 대시보드의 경우 대시보드와 연결된 팀의 고유 식별자입니다. 프로젝트 범위 대시보드의 경우 대시보드와 연결된 사용자 ID의 고유 식별자입니다.
position	integer (int32)	대시보드 그룹 내 대시보드의 위치입니다. 생성 시 설정되지 않은 경우 서비스에서 위치를 결정합니다.
refreshInterval	integer (int32)	클라이언트가 대시보드를 자동으로 새로 고치는 간격입니다. 분 단위로 표현됩니다.
url	string
widgets	Widget[]	대시보드의 위젯 집합입니다.

DashboardScope

열거형

대시보드 범위입니다. Project 또는 Project_Team

값	Description
collection_User	[사용되지 않음] 대시보드는 컬렉션 사용자로 범위가 지정됩니다.
project	대시보드의 범위는 프로젝트로 지정됩니다.
project_Team	대시보드의 범위는 팀으로 지정됩니다.

GroupMemberPermission

열거형

사용되지 않음: 현재 팀의 사용 권한 수준을 설명하는 이전 사용 권한 모델입니다. 사전 M125.

값	Description
edit
manage
managePermissions
none

LightboxOptions

Object

Lightbox 구성

Name	형식	Description
height	integer (int32)	원하는 라이트박스의 높이(픽셀)
resizable	boolean	lightbox 크기 조정을 허용하려면 True, lightbox 크기 조정을 허용하지 않는 false, 기본값은 false입니다.
width	integer (int32)	원하는 라이트박스의 너비(픽셀)

ReferenceLinks

Object

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

SemanticVersion

Object

에 설명된 대로 아티팩트 버전 관리: http://semver.org/( major.minor.patch)

Name	형식	Description
major	integer (int32)	호환되지 않는 API를 변경할 때 주 버전
minor	integer (int32)	이전 버전과 호환되는 방식으로 기능을 추가할 때 부 버전
patch	integer (int32)	이전 버전과 호환되는 버그 수정 시 패치 버전

TeamDashboardPermission

열거형

대시보드에 대한 현재 팀의 보안 권한을 설명하는 권한 비트 마스크입니다. 이 권한이 None 값이면 GroupMemberPermission을 사용합니다. 사용 권한은 None 이외의 값이 있는 경우를 기준으로 평가되며, 그렇지 않으면 GroupMemberPermission이 저장됩니다.

값	Description
create
delete
edit
managePermissions
none
read

Object

위젯 데이터

Name	형식	Description
_links	ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
allowedSizes	WidgetSize[]	위젯에 허용되는 크기를 나타냅니다. 사용자가 위젯을 구성하려고 할 때 채워집니다.
areSettingsBlockedForUser	boolean	대시보드 서비스의 Read-Only 속성입니다. 현재 사용자에 대한 설정이 차단되었는지를 나타냅니다.
artifactId	string	기능 아티팩트 고유 식별자를 참조합니다. 특정 아티팩트를 고정+고정 해제하는 데 사용됩니다.
configurationContributionId	string
configurationContributionRelativeId	string
contentUri	string
contributionId	string	제공된 위젯 구성을 정의하는 기본 기여의 ID입니다.
dashboard	Dashboard	위젯 수준 API에 대한 대시보드 수준 버전 ETag 교환을 지원하기 위한 선택적 부분 대시보드 콘텐츠
eTag	string
id	string (uuid)
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Lightbox 구성
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	에 설명된 대로 아티팩트 버전 관리: http://semver.org/( major.minor.patch)
size	WidgetSize
typeId	string
url	string

WidgetPosition

Object

Name	형식	Description
column	integer (int32)
row	integer (int32)

WidgetSize

Object

Name	형식	Description
columnSpan	integer (int32)	대시보드 그리드 열에 표현된 위젯의 너비입니다.
rowSpan	integer (int32)	대시보드 그리드 행에 표현된 위젯의 높이입니다.

다음을 통해 공유

Dashboards - Replace Dashboards

URI 매개 변수

요청 본문

응답

보안

oauth2

범위

예제

샘플 요청

샘플 응답

정의

Dashboard

DashboardGroup

DashboardGroupEntry

DashboardScope

GroupMemberPermission

LightboxOptions

ReferenceLinks

SemanticVersion

TeamDashboardPermission

Widget

WidgetPosition

WidgetSize