Implementazione dell'API generica (REST)

L'API generica (Rest) consente all'organizzazione di implementare un'API REST personalizzata che estrarrà i dati di telemetria dal sistema. InfoWorks WS Pro e IWLive Pro Operator Client sono client di questa API REST. Il reparto IT fornirà il server per l'API REST.

Di seguito sono definite le funzioni API che InfoWorks WS Pro e IWLive Pro Operator Client prevedono di trovare.

Il reparto IT è responsabile di garantire una sicurezza adeguata nell'implementazione di questa API REST.

URL base

Base_url sarà nel formato: https://MyTelemetry:Portnumber

Connessione di base

Base_url / nella scheda dati live, pagina di accesso, verrà visualizzato messaggio di esito positivo per "Test connection"

Elenco tag

Base_url /tags restituirà un elenco di tag per l'elenco a discesa Tag nella pagina dei feed di dati live.

Richiesta:

• Base_url/tags

Risposta:

• Esito positivo
  • {"tags": ["name"…]}
  • Esempio
    • {"tags": ["tag name 1","tag name 2","tag name 3","tag name 4"]}
• 500 {error: {message: error detail}}

Verificare che il tag esista

Base_url/tags/tagname conferma l'esistenza di un determinato nome tag.

Richiesta:

• Base_url/tags/tagname
• Parametri
  • limit=x (quanti)
    • default 1000
  • offset=y (inizio)
    • default 0

Risposta

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

Restituisce dati variabili nel tempo per un tag

Base_url/tags/tagname/history restituirà dati variabili nel tempo per un determinato tag.

Richiesta

• base_url/tags/tagname/history
  • Parametri
    • limit=x (quanti)
      • default 1000
    • offset=y (inizio)
      • default 0
    • startdate=YYYY-MM-DDThh:mm:ssZ
    • enddate= YYYY-MM-DDThh:mm:ssZ
    • order=a (ASC | DESC)
      • ASC di default

Risposta

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

Risposte di esempio

Esempio 1

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

Esempio 2

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

Esempio 3

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

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