SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

JIRAやConfluenceをもっと使いこなそう! エキスパートが教える、外部ツール連携術(AD)

REST APIを利用して、JIRAのサマリーを外部エディタで編集してみよう!――外部ツール連携の第一歩

JIRAやConfluenceをもっと使いこなそう! エキスパートが教える、外部ツール連携術 第1回

  • X ポスト
  • このエントリーをはてなブックマークに追加

REST APIでJIRAから課題を取得する

 ここで、先ほど動作させたソースコードの中からREST APIで課題を検索し、取得する部分を説明します。検索にはJQLを使用します。

課題検索クエリ
GET /rest/api/2/search

 課題検索結果は、デフォルトで最大50件です。maxResultsパラメーターを指定することで件数を変更できます。

レスポンス例
{
    "expand": "names,schema",
    "startAt": 0,
    "maxResults": 50,
    "total": 1,
    "issues": [
        {
            "expand": "",
            "id": "10001",
            "self": "http://www.example.com/jira/rest/api/2/issue/10001",
            "key": "HSP-1"
        }
    ],
    "warningMessages": [
        "The value 'splat' does not exist for the field 'Foo'."
    ]
}
課題検索REST APIの使用例
function loadIssues(editor, jql) {

  editor.setValue("loading issues...");

  $.ajax({
    type: "GET",
    url: hosturl + '/rest/api/2/search', // (1)
    dataType: 'json',
    data: {
      fields: 'summary',  // (2)
      jql: jql  // (3)
    },
    beforeSend: sendCredintials,
    success: function (res){  // (4)
.
.
.
  });
}

 処理の流れは以下の通りです。

  • (1)課題検索REST APIのエンドポイントを指定します。
  • (2)検索結果としてサマリーフィールドのみを取得します。必要なフィールドに絞ることで課題ロード時間を短縮することができます。
  • (3)ユーザーが入力したJQLを与えます。
  • (4)課題のロードが成功した場合、resに上記レスポンス例の形式で結果が返されます。$.ajaxは非同期呼び出しなので、successで結果を受けるより先に$.ajaxの呼び出しが終了することに注意してください。

REST APIでJIRAの課題を更新する

 次に課題の更新について説明します。ここではJSON表現のデータを使用します。

課題更新クエリ
PUT /rest/api/2/issue/{issueIdOrKey}
課題更新REST APIの使用例
function updateSummary(issueKey, value) {
.
.
.
  var result = 0;
  $.ajax({
    type: "PUT",  // (5)
    url: hosturl + '/rest/api/2/issue/' + issueKey,  // (6)
    contentType: 'application/json',
    data: JSON.stringify({  // (7)
      fields: {
        summary:  value
      }
    }),
    async: false,  // (8)
    beforeSend: sendCredintials,
    success: function (){
      result = 1;
    }
  });

  return result;
}

 処理の流れは以下の通りです。

  • (5)課題更新はPUTリクエストです。
  • (6)課題更新REST APIのエンドポイントを指定します。パスパラメーターに課題キーを含めます。
  • (7)更新内容を表すJSONデータを文字列化して与えます。
  • (8)ここでは実装を単純にするために同期モードで実行します。jQuery.DeferredやPromise等の非同期制御を使えば処理時間を短縮することができます。

REST APIの呼び出しを確認する

 Electronアプリケーションの実行中、開発者ツール(デバッガ)を使うことができます。これを使ってREST API呼び出しを確認してみましょう。

 メインメニューから、[View]→[Toggle Developer Tools]を選択するとアプリケーションウインドウの中に開発者画面が表示されます。

 Networkタブを選択した状態で課題ロードを実行すると、呼び出しに用いたパラメーラや呼び出し結果を簡単に確認することができます。

開発者画面の表示
開発者画面の表示

おわりに

 課題検索や課題更新以外にも、さまざまな要素に対するAPIが用意されており、多くの作業をJIRAの外部から行うことができます。特にExcelからVBAを経由してREST APIを利用する例はよくお見かけします。詳しくはリファレンスをご覧ください。

 また、ConfluenceやHipChat、Bitbucketなど、他のAtlassian製品も同様にREST APIが提供されています。今回作成したエディタを元に、便利な機能を作ってみてはいかがでしょうか?

参考リンク

リックソフトはアトラシアン製品アジアパシフィック売り上げ第1位(2015~2016年)

 リックソフト株式会社は、日本でトップレベルのAtlassian Platinum Solution Partnerです。アトラシアン製品の専任技術者が30人以上在籍しており、手厚いサポートを提供しています。また、豊富なライセンス購入特典もご用意しております。

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
JIRAやConfluenceをもっと使いこなそう! エキスパートが教える、外部ツール連携術連載記事一覧

もっと読む

この記事の著者

阿部 賢一(リックソフト株式会社)(アベ ケンイチ)

 さすらいの開発スナイパー。ソースコードの「早打ち」とバグへの「狙い撃ち」には定評がある。彼は言う。「コードを書いている時は、私の後ろに立つな!」

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

【AD】本記事の内容は記事掲載開始時点のものです 企画・制作 株式会社翔泳社

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/10128 2017/10/02 19:06

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング