Implementieren der generischen (Rest-)API

Die generische (REST-)API ermöglicht es Ihrem Unternehmen, eine maßgeschneiderte REST-API zu implementieren, die Telemetriedaten aus Ihrem System extrahiert. InfoWorks WS Pro und IWLive Pro sind Clients dieser REST-API. Ihre IT-Abteilung stellt den Server für die REST-API bereit.

Nachfolgend sind die API-Funktionen definiert, die InfoWorks WS Pro und IWLive Pro erwarten.

Ihre IT-Abteilung ist dafür verantwortlich, eine angemessene Sicherheit bei der Implementierung dieser REST-API zu gewährleisten.

Basis-URL

Base_url hat das folgende Format: https://MyTelemetry:Portnumber

Basisverbindung

Base_url / im Echtzeitdatenadapter, Anmeldeseite; der Erfolg für Verbindung testen wird angezeigt

Tag-Liste

Base_url /tags gibt eine Liste von Tags für das Dropdown-Menü Tags auf der Seite Echtzeitdatenfeeds zurück.

Anfrage:

• Base_url/tags

Reaktion:

• Erfolg
  • {"tags": ["name"...]}
  • Beispiel
    • {"tags": ["tag name 1","tag name 2","tag name 3","tag name 4"]}
• 500 {error: {message: error detail}}

Prüfen, ob das Tag vorhanden ist.

Base_url/tags/tagname bestätigt, dass ein bestimmter Tag-Name vorhanden ist.

Anfrage:

• Base_url/tags/tagname
• Parameter
  • limit=x (how many)
    • Vorgabe: 1000
  • offset=y (starting at)
    • Vorgabe: 0

Reaktion

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

Zeitvariable Daten für ein Tag zurückgeben

Base_url/tags/tagname/history gibt zeitvariable Daten für ein bestimmtes Tag zurück.

Anfrage

• base_url/tags/tagname/history
  • Parameter
    • limit=x (how many)
      • Vorgabe: 1000
    • offset=y (starting at)
      • Vorgabe: 0
    • startdate=YYYY-MM-DDThh:mm:ssZ
    • enddate= YYYY-MM-DDThh:mm:ssZ
    • order=a (ASC | DESC)
      • Vorgabe-ASC

Reaktion

• 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

Beispiele für Reaktionen

Beispiel 1

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

Beispiel 2

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

Beispiel 3

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

Beispiel 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
			}
		]
}
}