Chiamare un'API REST

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

Per chiamare un'API REST dall'estensione, ottenere prima il servizio client e quindi usarlo per chiamare l'API.

Nota

Per informazioni sulle API REST di Azure DevOps Vedere la documentazione di riferimento più recente sull'API REST di Azure DevOps.

Per informazioni sulle librerie client .NET, vedere Librerie client .NET per Azure DevOps.

Servizi client

È possibile trovare l'elenco completo dei client REST disponibili e i relativi riferimenti qui.

Chiamare un'API

Sarà necessario aggiungere l'ambito all'utente "scopes": ["vso.work"],vss-extension.json per usare il client di rilevamento degli elementi di lavoro.

  1. Ottenere il client REST. In questo caso, viene ottenuto il client di rilevamento degli elementi di lavoro.

    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. Chiamare l'API , getWorkItems, usando il servizio client , witClientcon un callback che gestisce i risultati.

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

Passaggi successivi

Visualizzare i risultati della chiamata API REST in una griglia.