Widget Types - Get Widget Types

参考

服务:: Dashboard

API 版本:: 7.1-preview.1

按字母顺序获取所有可用的小组件元数据，包括标记为 isVisibleFromCatalog == false 的小组件。

GET https://dev.azure.com/{organization}/{project}/_apis/dashboard/widgettypes?$scope={$scope}&api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
$scope	query	True	WidgetScope
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	WidgetTypesResponse	成功操作

安全性

oauth2

类型: oauth2
流向: 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

作用域

名称	说明
vso.dashboards	授予读取团队仪表板信息的能力

示例

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/dashboard/widgettypes?api-version=7.1-preview.1

示例响应

状态代码:: 200

{
  "widgetTypes": [
    {
      "typeId": "Microsoft.VSO.Dashboards.SprintBurndown",
      "name": "First Party Widget: Sprint Burndown",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintBurndownPreview.png",
      "description": "Used to show the sprint burndown",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "_widgets/SprintBurndown",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "46b71d63-f0e1-4176-b776-7957107f5436",
          "namespace": "dashboards.sprint-burndown V1",
          "version": "0.0.1",
          "name": "Sprint Burndown Widget",
          "description": "Shows the burndown for the current sprint",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintBurndownPreview.png",
          "contributions": {
            "vs.Dashboards.web#widgets": [
              {
                "id": "Microsoft.VSO.Dashboards.SprintBurndown",
                "name": "First Party Widget: Sprint Burndown",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintBurndownPreview.png",
                "description": "Used to show the sprint burndown",
                "uri": "_widgets/SprintBurndown",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:55.103Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widgets",
          "id": "vs.Dashboards.web#widgets"
        },
        "properties": {
          "id": "Microsoft.VSO.Dashboards.SprintBurndown",
          "name": "First Party Widget: Sprint Burndown",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintBurndownPreview.png",
          "description": "Used to show the sprint burndown",
          "uri": "_widgets/SprintBurndown",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VisualStudioOnline.Dashboards.VSLinks",
      "name": "VS Links Widget",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/vsLinksPreview.png",
      "description": "Shows 2 Visual Studio Links, one for download, the other to open VS.",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/VSLinks",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "249960d3-10c0-4b73-aa90-8af01d2fabc7",
          "namespace": "dashboards.vs-links",
          "version": "0.0.1",
          "name": "Visual Studio Links Widget",
          "description": "Shows 2 Visual Studio Links, one for download, the other to open VS",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/vsLinksPreview.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VisualStudioOnline.Dashboards.VSLinks",
                "name": "VS Links Widget",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/vsLinksPreview.png",
                "description": "Shows 2 Visual Studio Links, one for download, the other to open VS.",
                "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/VSLinks",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:55.6Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VisualStudioOnline.Dashboards.VSLinks",
          "name": "VS Links Widget",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/vsLinksPreview.png",
          "description": "Shows 2 Visual Studio Links, one for download, the other to open VS.",
          "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/VSLinks",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VisualStudioOnline.Dashboards.TeamMembers",
      "name": "Team Members Widget",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamMembersPreview.png",
      "description": "Displays the number of team members for the project and a random assortment of team member profile pictures",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamMembers",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "1da91185-b1cd-409a-af57-8e8d414014a1",
          "namespace": "dashboards.team-members",
          "version": "1.0.0",
          "name": "Team Members Widget",
          "description": "Displays the number of team members for the project and a random assortment of team member profile pictures",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamMembersPreview.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VisualStudioOnline.Dashboards.TeamMembers",
                "name": "Team Members Widget",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamMembersPreview.png",
                "description": "Displays the number of team members for the project and a random assortment of team member profile pictures",
                "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamMembers",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:55.383Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VisualStudioOnline.Dashboards.TeamMembers",
          "name": "Team Members Widget",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamMembersPreview.png",
          "description": "Displays the number of team members for the project and a random assortment of team member profile pictures",
          "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamMembers",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
      "name": "Other Links Widget",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
      "description": "Shows relavant links for the team.",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "bfb0eae0-a71f-469d-a021-9e650546db6b",
          "namespace": "dashboards.other-links",
          "version": "0.0.1",
          "name": "Other Links Widget",
          "description": "Shows relavant links for the team",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
                "name": "Other Links Widget",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
                "description": "Shows relavant links for the team.",
                "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:54.827Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VisualStudioOnline.Dashboards.OtherLinks",
          "name": "Other Links Widget",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/otherLinksPreview.png",
          "description": "Shows relavant links for the team.",
          "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/OtherLinks",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VisualStudioOnline.Dashboards.TeamRoom",
      "name": "Team Room Widget",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamRoomPreview.png",
      "description": "Shows current team room status for all teams in the project",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamRoom",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "dba5ed6b-10fe-4469-b1ea-bd57492cdcc7",
          "namespace": "dashboards.team-room",
          "version": "0.0.1",
          "name": "Team Room Widget",
          "description": "Shows current team room status for all teams in the project",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamRoomIcon.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VisualStudioOnline.Dashboards.TeamRoom",
                "name": "Team Room Widget",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamRoomPreview.png",
                "description": "Shows current team room status for all teams in the project",
                "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamRoom",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:55.497Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VisualStudioOnline.Dashboards.TeamRoom",
          "name": "Team Room Widget",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/teamRoomPreview.png",
          "description": "Shows current team room status for all teams in the project",
          "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/TeamRoom",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VisualStudioOnline.Dashboards.WorkLinksWidget",
      "name": "Work Links Widget",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/workLinksPreview.png",
      "description": "Display Work Links",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/WorkLinks",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "340a1bd5-9a00-4e05-a178-e48454e71107",
          "namespace": "dashboards.worklinks",
          "version": "0.0.1",
          "name": "Work Links Widget",
          "description": "Display Work Links",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/workLinksWidgetIcon.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VisualStudioOnline.Dashboards.WorkLinksWidget",
                "name": "Work Links Widget",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/workLinksPreview.png",
                "description": "Display Work Links",
                "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/WorkLinks",
                "isVisibleFromCatalog": true,
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:56.037Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VisualStudioOnline.Dashboards.WorkLinksWidget",
          "name": "Work Links Widget",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}_static/Widgets/workLinksPreview.png",
          "description": "Display Work Links",
          "uri": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"ProjectCollection\"}}{{project.name}}/_widgets/WorkLinks",
          "isVisibleFromCatalog": true,
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    },
    {
      "typeId": "Microsoft.VSO.Dashboards.SprintCapacity",
      "name": "First Party Widget: Sprint Capacity",
      "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintCapacityPreview.png",
      "description": "Used to show the sprint capacity",
      "isVisibleFromCatalog": true,
      "isEnabled": true,
      "contentUri": "_widgets/SprintCapacity",
      "allowedSizes": [
        {
          "rowSpan": 1,
          "columnSpan": 2
        }
      ],
      "contribution": {
        "extension": {
          "id": "53169f02-a2d5-4ae1-8456-fde6c6a9118e",
          "namespace": "dashboards.sprint-capacity V1",
          "version": "0.0.1",
          "name": "Sprint Capacity Widget",
          "description": "Shows the capacity information, user story status in the current sprint",
          "provider": {
            "name": "Microsoft",
            "website": "https://www.microsoft.com"
          },
          "icon": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintCapacityPreview.png",
          "contributions": {
            "vs.Dashboards.web#widget": [
              {
                "id": "Microsoft.VSO.Dashboards.SprintCapacity",
                "name": "First Party Widget: Sprint Capacity",
                "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintCapacityPreview.png",
                "description": "Used to show the sprint capacity",
                "uri": "_widgets/SprintCapacity",
                "supportedSizes": [
                  {
                    "rowSpan": 1,
                    "columnSpan": 2
                  }
                ]
              }
            ]
          },
          "publishInfo": {
            "store": {
              "extensionStoreType": "builtIn",
              "target": "0093aaee-9eff-4562-a0f2-8ea21a4cc590"
            },
            "ownerId": "6915b3ed-b527-4a61-812e-19d0629e2e08",
            "lastUpdated": "2015-05-12T21:18:55.193Z"
          }
        },
        "point": {
          "extensionNamespace": "vs.Dashboards.web",
          "extensionRelativeId": "widget",
          "id": "vs.Dashboards.web#widget"
        },
        "properties": {
          "id": "Microsoft.VSO.Dashboards.SprintCapacity",
          "name": "First Party Widget: Sprint Capacity",
          "previewImageUrl": "{{ServiceUrl \"00025394-6065-48CA-87D9-7F5672854EF7\" \"Application\"}}/_static/Widgets/sprintCapacityPreview.png",
          "description": "Used to show the sprint capacity",
          "uri": "_widgets/SprintCapacity",
          "supportedSizes": [
            {
              "rowSpan": 1,
              "columnSpan": 2
            }
          ]
        }
      }
    }
  ],
  "uri": "https://dev.azure.com/fabrikam/_apis/Dashboard/WidgetTypes"
}

定义

名称	说明
LightboxOptions	Lightbox 配置
ReferenceLinks	表示 REST 引用链接集合的类。
WidgetMetadata	描述仪表板小组件的基于贡献的信息。
WidgetScope	小组件正常运行并在其容器中工作所需的数据协定。
WidgetSize
WidgetTypesResponse

LightboxOptions

Object

Lightbox 配置

名称	类型	说明
height	integer (int32)	所需灯箱的高度（以像素为单位）
resizable	boolean	如果为 True，则允许灯箱大小调整，false 禁止重设灯箱大小，默认值为 false。
width	integer (int32)	所需灯箱的宽度（以像素为单位）

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

WidgetMetadata

Object

描述仪表板小组件的基于贡献的信息。

名称	类型	说明
allowedSizes	WidgetSize[]	小组件支持的大小。
analyticsServiceRequired	boolean	选择加入布尔值，指示小组件是否需要分析服务正常运行。如果分析服务不可用，则要求分析服务的小组件会从目录中隐藏。
catalogIconUrl	string	小组件目录中图标的资源。
catalogInfoUrl	string	选择加入 URL 字符串指向小组件信息。如果省略，则默认为扩展市场 URL
configurationContributionId	string	定义提供的小组件自定义配置 UI 的基础贡献的 ID。如果自定义配置 UI 不可用，则为 Null。
configurationContributionRelativeId	string	定义提供的小组件自定义配置 UI 的基础贡献的相对 ID。如果自定义配置 UI 不可用，则为 Null。
configurationRequired	boolean	指示小组件在添加到仪表板之前是否需要配置。
contentUri	string	要从中加载的小组件内容的 URI。
contributionId	string	定义提供的小组件的基础贡献的 ID。
defaultSettings	string	要复制到小组件设置中的可选默认设置。
description	string	描述小组件的摘要信息。
isEnabled	boolean	小组件可由应用商店禁用。我们需要正常处理： - 持久性（允许） - 请求（标记为禁用，并提供上下文）
isNameConfigurable	boolean	选择退出布尔值，指示小组件是否支持小组件名称/游戏配置。忽略名称的小组件应在清单中将其设置为 false。
isVisibleFromCatalog	boolean	选择退出布尔值，指示小组件是否隐藏在目录中。通常，这用于允许开发人员禁用创建已弃用的小组件。小组件必须具有功能默认状态或具有配置体验才能从目录中可见。
keywords	string[]	与此小组件关联的关键字，不可筛选且不可见
lightboxOptions	LightboxOptions	选择加入属性以在“lightbox”对话框中自定义小组件演示文稿。
loadingImageUrl	string	仪表板上加载占位符图像的资源
name	string	小组件类型的面向用户的名称。每个小组件必须在此处使用唯一值。
publisherName	string	此类小组件的发布者名称。
supportedScopes	WidgetScope[]	小组件正常运行并在其容器中工作所需的数据协定。
tags	string[]	与此小组件关联的标记，在每个小组件上可见并可筛选。
targets	string[]	贡献目标 ID
typeId	string	已弃用：这种小组件的本地唯一面向开发人员的 ID。 ContributionId 为小组件类型提供全局唯一标识符。

WidgetScope

枚举

小组件正常运行并在其容器中工作所需的数据协定。

值	说明
collection_User
project_Team

WidgetSize

Object

名称	类型	说明
columnSpan	integer (int32)	小组件的宽度，以仪表板网格列表示。
rowSpan	integer (int32)	小组件的高度，以仪表板网格行表示。

WidgetTypesResponse

Object

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
uri	string
widgetTypes	WidgetMetadata[]	描述仪表板小组件的基于贡献的信息。

通过

Widget Types - Get Widget Types

URI 参数

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

LightboxOptions

ReferenceLinks

WidgetMetadata

WidgetScope

WidgetSize

WidgetTypesResponse

其他资源