Een REST API aanroepen

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

Aanbeveling

Voor de nieuwste richtlijnen voor uitbreidingsontwikkeling, inclusief thema's en migratie van VSS. SDK raadpleegt u de ontwikkelaarsportal van de Azure DevOps Extension SDK.

Als u een REST API wilt aanroepen vanuit uw extensie, haalt u eerst de clientservice op en gebruikt u deze vervolgens om de API aan te roepen.

Een API aanroepen

Voeg het bereik "scopes": ["vso.work"], toe aan uw vss-extension.json om de client voor het bijhouden van werkitems te gebruiken.

  1. Haal de REST-client op. In dit voorbeeld gebruikt u de client voor het bijhouden van werkitems.

    import * as SDK from "azure-devops-extension-sdk";
    import { WorkItemTrackingRestClient } from "azure-devops-extension-api/WorkItemTracking";
    import { getClient } from "azure-devops-extension-api";
    
    SDK.init();
    SDK.ready().then(async () => {
        const witClient = getClient(WorkItemTrackingRestClient);
        // ...
    });
    
  2. Roep de API getWorkItemsaan met behulp van de client met een callback die resultaten verwerkt.

    const workItems = await witClient.getWorkItems([1, 2, 3, 4], undefined, ["System.Title"]);
    console.log(JSON.stringify(workItems));