调用 REST API

  • 项目

Azure DevOps Services |Azure DevOps Server 2022 - Azure DevOps Server 2019 |TFS 2018

若要从扩展调用 REST API，请先获取客户端服务，然后使用它调用 API。

注意

正在查找 Azure DevOps REST API？ 请参阅最新的 Azure DevOps REST API 参考。

有关 .NET 客户端库的信息，请参阅 适用于 Azure DevOps 的 .NET 客户端库。

客户端服务

可 在此处找到可用 REST 客户端及其引用的完整列表。

调用 API

你必须将范围 "scopes": ["vso.work"], 添加到你 vss-extension.json ，才能使用工作项跟踪客户端。

  1. 获取 REST 客户端。 在这种情况下，我们将获取 工作项跟踪客户端。

    VSS.require(["VSS/Service", "TFS/WorkItemTracking/RestClient"], function (VSS_Service, TFS_Wit_WebApi) {
    // Get the REST client
    var witClient = VSS_Service.getCollectionClient(TFS_Wit_WebApi.WorkItemTrackingHttpClient);
    // ...
});

  2. 使用客户端服务调用 API getWorkItems， witClient并使用处理结果的回调。

    witClient.getWorkItems(/* some work item IDs */ [1,2,3,4], ["System.Title"]).then(
    function(workItems) {
     	console.log(JSON.stringify(workItems));
    });

后续步骤

在 网格中显示 REST API 调用的结果。