Implémentation de l’API générique (REST)

L’API générique (REST) générique permet à votre organisation d’implémenter une API REST sur mesure qui extrait les données de télémétrie de votre système. InfoWorks WS Pro et IWLive Pro sont des clients de cette API REST. Votre service informatique fournira le serveur pour l’API REST.

Les fonctions API qu’InfoWorks WS Pro et IWLive Pro s’attendent à trouver sont définies ci-dessous.

Votre service informatique est responsable de la mise en place d’une sécurité adéquate dans l’implémentation de cette API REST.

URL de base

Base_url se présenter comme suit : https://MyTelemetry:Portnumber

Connexion de base

Base_url / dans l’adaptateur de données actives, page de connexion, indiquera que le test de connexion a réussi

Liste des balises

Base_url /tags renvoie une liste de balises pour la liste déroulante Balises dans la page des flux de données actives.

Requête :

• Base_url/tags

Réponse :

• Succès
  • {"tags": ["name"…]}
  • Exemple
    • {"tags": ["tag name 1","tag name 2","tag name 3","tag name 4"]}
• 500 {error: {message: error detail}}

Vérifier que la balise existe

Base_url/tags/tagname confirme qu’un nom de balise particulier existe.

Requête :

• Base_url/tags/tagname
• Paramètres
  • limit=x (how many)
    • default 1000
  • offset=y (staring at)
    • default 0

Réponse :

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

Renvoyer des données temporelles pour une balise

Base_url/tags/tagname/history renverra des données temporelles pour une balise particulière.

Requête :

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

Réponse :

• 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

Exemples de réponses

Exemple 1

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

Exemple 2

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

Exemple 3

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

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