Widgets - Get Widget

참조

서비스:: Dashboard

API 버전:: 7.1-preview.2

지정된 위젯의 현재 상태를 가져옵니다.

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId}?api-version=7.1-preview.2

URI 매개 변수

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

응답

Name	형식	Description
200 OK	Widget	성공적인 작업

보안

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	팀 dashboard 정보를 읽을 수 있는 권한을 부여합니다.

예제

샘플 요청

HTTP

GET https://dev.azure.com/fabrikam/{project}/_apis/dashboard/dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf?api-version=7.1-preview.2

샘플 응답

상태 코드:: 200

{
  "id": "69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "eTag": "5",
  "name": "Other Links",
  "position": {
    "row": 1,
    "column": 1
  },
  "size": {
    "rowSpan": 1,
    "columnSpan": 2
  },
  "settings": null,
  "settingsVersion": {
    "major": 1,
    "minor": 0,
    "patch": 0
  },
  "dashboard": {
    "eTag": "18"
  },
  "contributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.OtherLinksWidget",
  "url": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets/69f6c5b7-0eb0-4067-b75f-6edff74d0fcf"
    },
    "group": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a/widgets"
    },
    "dashboard": {
      "href": "https://dev.azure.com/fabrikam/6c9633e5-5633-4b1d-8081-02b35e39258e/8b69d2eb-2e18-4c75-a1ca-4c1820800e2e/_apis/Dashboard/Dashboards/e17c2ae9-c35c-4ddd-9d4b-6aa47aa4d01a"
    }
  }
}

정의

Name	Description
Dashboard	대시보드의 모델입니다.
DashboardScope	대시보드 범위. Project 또는 Project_Team
LightboxOptions	Lightbox 구성
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
SemanticVersion	major.minor.patch 형식의 에 http://semver.org/설명된 대로 아티팩트 버전 관리
Widget	위젯 데이터
WidgetPosition
WidgetSize

Dashboard

Object

대시보드의 모델입니다.

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

DashboardScope

Enumeration

대시보드 범위. Project 또는 Project_Team

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

LightboxOptions

Object

Lightbox 구성

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

ReferenceLinks

Object

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

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

SemanticVersion

Object

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

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

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에 대한 dashboard 수준 버전 ETag 교환을 지원하기 위한 선택적 부분 dashboard 콘텐츠
eTag	string
id	string
isEnabled	boolean
isNameConfigurable	boolean
lightboxOptions	LightboxOptions	Lightbox 구성
loadingImageUrl	string
name	string
position	WidgetPosition
settings	string
settingsVersion	SemanticVersion	major.minor.patch 형식의 에 http://semver.org/설명된 대로 아티팩트 버전 관리
size	WidgetSize
typeId	string
url	string

WidgetPosition

Object

Name	형식	Description
column	integer
row	integer

WidgetSize

Object

Name	형식	Description
columnSpan	integer	dashboard 그리드 열로 표현되는 위젯의 너비입니다.
rowSpan	integer	dashboard 그리드 행으로 표현되는 위젯의 높이입니다.

다음을 통해 공유

Widgets - Get Widget

URI 매개 변수

응답

보안

oauth2

범위

예제

샘플 요청

샘플 응답

정의

Dashboard

DashboardScope

LightboxOptions

ReferenceLinks

SemanticVersion

Widget

WidgetPosition

WidgetSize