Llamar a una API REST

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

Para llamar a una API REST desde la extensión, obtenga primero el servicio de cliente y después úselo para llamar a la API.

Nota:

¿Buscas API REST de Azure DevOps? Consulte la referencia más reciente de la API rest de Azure DevOps.

Para obtener información sobre las bibliotecas cliente de .NET, consulte Bibliotecas cliente de .NET para Azure DevOps.

Servicios de cliente

Puede encontrar la lista completa de clientes REST disponibles y sus referencias aquí.

Llamada a una API

Tendrá que agregar el ámbito "scopes": ["vso.work"], a vss-extension.json para usar el cliente de seguimiento de elementos de trabajo.

  1. Obtenga el cliente REST. En este caso, se obtiene el cliente de seguimiento de elementos de trabajo.

    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. Llame a la API, getWorkItems, mediante el servicio de cliente, witClient, con una devolución de llamada que controle los resultados.

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

Pasos siguientes

Muestra los resultados de la llamada a la API REST en una cuadrícula.