Anropa ett REST-API

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

Tips/Råd

För den senaste utvecklingsvägledningen för tillägg, inklusive teman och migrering från VSS. SDK, se utvecklarportalen för Azure DevOps Extension SDK.

Om du vill anropa ett REST-API från tillägget hämtar du klienttjänsten först och använder den sedan för att anropa API:et.

Anmärkning

Letar du efter REST-API:er för Azure DevOps? Se den senaste REST API-referensen för Azure DevOps.

Information om .NET-klientbibliotek finns i .NET-klientbibliotek för Azure DevOps.

Anropa ett API

Lägg till omfånget "scopes": ["vso.work"], till din vss-extension.json för att använda spårningsklienten för arbetsobjekt.

  1. Hämta REST-klienten. I det här exemplet använder du spårningsklienten för arbetsobjekt.

    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. Anropa API:et, getWorkItems, med hjälp av klienten för att hantera resultat med en callback-funktion.

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