Swagger UIのHTTP APIを使用してSystemLink上のファイル情報を取得する

更新しました May 7, 2024

環境

ソフトウェア

  • SystemLink Server
  • LabVIEW
  • JSONtext

SystemLink Webアプリケーション上の多くの操作は、HTTP APIを使用して外部アプリケーションから制御できます。この記事では、Swagger UIでHTTP APIを使用してファイルのメタデータを取得または設定する方法が説明されています。SystemLinkにファイルをアップロードする方法に関する基本的な知識があることを前提としています。

Swagger上でSystemLink File Serviceを選択します。
sl.PNG

SystemLink File ServiceのGET/v1/service-groups/Default /filesコマンドのセクションに移動します。
この HTTP APIは、クエリ設定に基づいてファイル情報を返します。
 
  1. Try it Outをクリックします。
  2. 必要に応じて、Skip(ページング時にスキップするファイルの数)、take(結果で返すファイルの数)、およびその他のフィルター パラメーターを設定します。
以下の例では、50 個の利用可能なファイルのリストをtakeするクエリを送信します。
 
ファイルSL.PNG
 
  1. Executeをクリックします。
HTTP APIが正常に実行されると、Response bodyCode 200が返されます。さらに、SystemLinkサーバ上で利用可能なファイルの総数が、このResponse bodyの最後の行あるtotalCount値として表示されます。
 
ファイルSL2.PNG


以下のプログラムを使用して、LabVIEWから同様のリクエストを実行できます。 この例では、Response bodyにテキストを並べ替えてtotalCount値を取得するためにJSONtextライブラリが必要です。JSONtextはVI パッケージ マネージャーからダウンロードできます)

ファイル情報を取得.png

ファイルSLResult.PNG