Generic (REST) API を実装する

Generic (REST) API を使用すると、組織は、システムからテレメトリを抽出するカスタムメイドの REST API を実装できます。InfoWorks WS Pro および IWLive Pro Operator Clientは、この REST API のクライアントです。REST API 用のサーバーは、IT 部門が用意します。

次に、InfoWorks WS Pro および IWLive Pro Operator Clientが検索する API 関数を定義します。

IT 部門は、この REST API の実装において適切なセキュリティを確保する責任があります。

Base URL

Base_url は、https://MyTelemetry:Portnumber の形式になります

基本的な接続

Base_url /。ライブ データ アダプタのログオン ページには "テスト接続" の成功が表示されます

タグの一覧

Base_url /tags は、ライブ データ ソース ページの[タグ]ドロップ ダウンのタグの一覧を返します。

要求:

• Base_url/tags

応答:

• 成功
  • {"tags": ["name"…]}
  • 例
    • {"tags": ["tag name 1","tag name 2","tag name 3","tag name 4"]}
• 500 {error: {message: error detail}}

タグが存在することを確認する

Base_url/tags/tagname は、特定のタグ名が存在することを確認します。

要求:

• Base_url/tags/tagname
• パラメータ
  • limit=x (個数)
    • 既定は 1000
  • offset=y (開始位置)
    • 既定は 0

応答

• 404 {"error": "Tag not found"}
• 500 {error: {message: error detail}}
• Success {"exists": true}

タグの時系列データを返す

Base_url/tags/tagname/history は、特定のタグの時系列データを返します。

要求

• base_url/tags/tagname/history
  • パラメータ
    • limit=x (個数)
      • 既定は 1000
    • offset=y (開始位置)
      • 既定は 0
    • startdate=YYYY-MM-DDThh:mm:ssZ
    • enddate= YYYY-MM-DDThh:mm:ssZ
    • order=a (ASC | DESC)
      • 既定は ASC

応答

• 404 {"error": "Tag not found"}
• 404 {"error": "History not found"}
• 500 {error: {message: error detail}}
• Success {"result": {"tagname": "aaa","values": [ {"timestamp":"ISO_datetime": "valueTypeName": value}…]}}
  • ISO datetime YYYY-MM-DDThh:mm:ss.mmmZ
  • ValueTypeName
    • doubleValue
    • integerValue
    • booleanValue
    • stringValue

応答例

例 1

{
"result": {"tagname":"tag name 2","values": [{"timestamp":"2023-09-01T23:00:00.000Z","integerValue": 0}]
}

例 2

{
"result": {"tagname":"tag name 3","values": [{"timestamp":"2023-09-01T23:00:00.000Z","booleanValue": false}]
}

例 3

{
"result": {"tagname":"tag name 4","values": [{"timestamp":"2023-09-01T23:00:00.000Z","stringValue": "ABC2460189.5"}]
}

例 4

{
 	"result": {
		"tagname": "tag name 15",
		"values": [
			{
				"timestamp": "2024-03-15T09:40:00.000Z",
				"doubleValue": -0.9659258262890684
			},
			{
				"timestamp": "2024-03-15T09:45:00.000Z",
				"doubleValue": -0.9612616959383188
			}
		]
}
}