Aufrufen einer REST-API

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Um eine REST-API aus Ihrer Erweiterung aufzurufen, rufen Sie zuerst den Clientdienst ab, und verwenden Sie sie dann, um die API aufzurufen.

Hinweis

Suchen Sie nach Azure DevOps REST-APIs? Weitere Informationen finden Sie in der neuesten Referenz zur Azure DevOps REST-API.

Informationen zu .NET-Clientbibliotheken finden Sie unter .NET-Clientbibliotheken für Azure DevOps.

Clientdienste

Hier finden Sie die vollständige Liste der verfügbaren REST-Clients und deren Referenzen.

Aufrufen einer Web-API

Sie müssen dem Bereich "scopes": ["vso.work"], hinzufügen vss-extension.json , um den Arbeitsaufgabenverfolgungsclient zu verwenden.

  1. Rufen Sie den REST-Client ab. In diesem Fall erhalten wir den Client für die Nachverfolgung von Arbeitsaufgaben.

    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. Rufen Sie die API mithilfe des Clientdiensts mit einem Rückruf auf, getWorkItemswitClientder Ergebnisse verarbeitet.

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

Nächste Schritte

Zeigen Sie die Ergebnisse Ihres REST-API-Aufrufs in einem Grid an.