Node.js からJira Assets のデータをクエリ

CData API Server とADO.NET Provider for JiraAssets(もしくは240+ の他のADO.NET Providers)を使って、Jira Assets をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたJira Assets のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなJira Assets OData サービスを作成していきましょう。

Jira Assets への接続

NodeJS からJira Assets のデータを操作するには、まずJira Assets への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Jira Assets」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Jira Assets への接続設定を行っていきましょう！

5. Jira Assets は、APIToken 経由での接続と認証をサポートしています。

   API トークンを生成するには：

   1. Atlassian アカウントにログインします。
   2. セキュリティ設定 > API トークン > API トークンを作成するをクリックします。

   Atlassian がAPI トークンを生成して表示します。

   API トークンを生成したら、以下のパラメータをセットします。

   • AuthScheme：APIToken。
   • User：認証するユーザーのログイン名。
   • APIToken：生成したAPI トークン。

   これでJira Assets に接続して認証する準備が整いました。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Jira Assets は、APIToken 経由での接続と認証をサポートしています。

API トークンを生成するには：

1. Atlassian アカウントにログインします。
2. セキュリティ設定 > API トークン > API トークンを作成するをクリックします。

Atlassian がAPI トークンを生成して表示します。

API トークンを生成したら、以下のパラメータをセットします。

• AuthScheme：APIToken。
• User：認証するユーザーのログイン名。
• APIToken：生成したAPI トークン。

これでJira Assets に接続して認証する準備が整いました。

API Server のユーザー設定

次に、API Server 経由でJira Assets にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Jira Assets 用のAPI エンドポイントの作成

ユーザーを作成したら、Jira Assets のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でJira Assets への接続を設定してユーザーを作成し、API Server でJira Assets データのAPI を追加しました。これで、OData 形式のJira Assets データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からJira Assets OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはObjects データに対して認証されたリクエストを行います。 以下のURL の例では、Label カラムの値がSYD-1 のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Objects?$filter=" + encodeURIComponent("Label eq 'SYD-1'"),
  auth:'MyUser:MyAuthtoken'
},
function(res) {
  var body = '';
  res.on('data', function(chunk) {
    body += chunk;
  });
  res.on('end', function() {
    console.log(body);
    var jsonData = JSON.parse(body);
  });
}).on('error', function(e) {
  console.log("Error: ", e);
});