Swagger UIでHTTP APIを使用してSystemLinkで作成したタグの値を取得する

更新しました Feb 3, 2021

環境

ソフトウェア

  • SystemLink
  • SystemLink Server 2020 R3
  • SystemLink Server
  • SystemLink TDM DataFinder Module

その他

  • Swagger

SystemLink Web Application上の操作の多くはHTTP APIを使用する事で外部アプリケーションからの制御が可能となっています。ここではタグの値を取得するHTTP APIの挙動をSwaggerで確認します。ここで確認するHTTP APIはLabVIEWで作成したプログラムで使用可能となっており、例えばクライアントPC、cRIO、PXIコントローラで実行しているVIからHTTP APIを使用して、SystemLinkサーバに対して制御を行うことができます。
 

SystemLink タグビューワでタグを作成する


1. SystemLink Web Applicationにログインし、データ視覚化のタグビューワを開きます。タグビューワの「作成」から任意の名前でタグを作成します。下記の例ではtestという名前のタグを作成しています。
 

2. 作成したタグをダブルクリックし、「値」の項目に任意の数値を入力し、保存します。

 

Swagger UIでHTTP APIを実行し、タグの値を取得する


1. タグビューワの右上の?マークの部分からHTTP APIを選択し、Swagger UIを開きます。
 


2. SystemLink Tag ServiceのSwagger UIページでGET /v2/tags/{path}/values/currentを選択します。
 


3. Try it Outをクリックし、このHTTP APIを実行します。先ほど作成したtestというタグの値を得るには下記の様に設定し、Executeを実行します。



HTTP APIが正常に実行されると上記の通り、Code 200、Response body、Response headersが返ってきます。

次のステップ

タグに値を書き込む場合、PUT /v2/tags/{path}/values/currentを使用します。下記の様に設定項目を編集し、実行するとタグの値が書き換わります。
 

上記のHTTP APIを実行すると下記の様にタグの値が書き換わります。
 

これらのHTTP APIをLabVIEWから実行する方法はこちらで確認できます。

関連リンク

その他のサポートオプション

NIコミュニティに聞く

ディスカッションフォーラムで他のユーザーとコラボレーション



エンジニアからのサポートをリクエストする

有効なサービス契約が必要な場合があり、サポートオプションは国によって異なります。