Jira の Issue 一覧を取得するのにずっとIssueを使うものだと思っていたが、Search を使うのが正しいようだ。

Jira で検索を行うと jql という検索クエリを打つことになる。これをそのまま使って Issue を検索・一覧を取得できるのでこれだと知っておけば簡単に利用できる。ありがたい。

お仕事で Google App Scripts から JIRA の API を叩いてチケット一覧を Google Spread Sheets に転記、ということをやってみた際に検索方法がわからなかったのでメモであった。

サンプルコード

userName は当然にユーザ名、token はAtlassian アカウントの API トークンを管理する | アトラシアン サポートを参考に取得すること。

また、jql はJQL: Jira で高度な検索機能を使い始める | Atlassianを読んで理解すると良いと思う。ないしは Jira で単純に検索した上でアドレスバーを見るとわかるかも。

const getIssueList = (jql) => {
  const userName = 'hiyoko';
  const token = 'token';
  const base64Encoded = Utilities.base64Encode(`${userName}:${token}`);
  const domain = `https://shunshun94-example.atlassian.net/rest/api/2/search?jql=${jql}`;
  const requestResult = UrlFetchApp.fetch(url, {
    'headers': {
      'Authorization': `Basic ${base64Encoded}`
    }
  });
  const issueList = JSON.parse(requestResult.toString()).issues;
  return issueList;
};