REST API を呼び出す

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

ヒント

テーマ設定や VSS からの移行など、最新の拡張機能開発ガイダンスについて説明します。SDK については、 Azure DevOps Extension SDK 開発者ポータルを参照してください。

拡張機能から REST API を呼び出すには、最初にクライアント サービスを取得してから、それを使用して API を呼び出します。

注

Azure DevOps REST API をお探しですか? 最新の Azure DevOps REST API リファレンス を参照してください。

Azure DevOps の .NET クライアント ライブラリについての情報は、.NET クライアント ライブラリのページ を参照してください。

API を呼び出す

作業項目追跡クライアントを使用するために、スコープ "scopes": ["vso.work"], を vss-extension.json に追加します。

  1. REST クライアントを取得します。 この例では、作業項目追跡クライアントを使用します。

    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. API getWorkItemsをクライアントで、結果を処理するコールバックを使用して呼び出します。

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