Buch erstellen
 Diese Seite zum Buch hinzufügen
Buch erstellen
 Diese Seite aus Buch entfernen  

 Buch anzeigen, ändern (0 Seite/n)
 Hilfe

REST Interface Plugin

Allgemein

Das REST Interface Plugin erlaubt den Zugriff auf die Nodes von CoDaBix® über HTTP Anfrage formatiert als JSON Objekt.

Das REST Interface Plugin erlaubt den Zugriff auf die Nodes von CoDaBix® über HTTP Anfrage formatiert als JSON Objekt.

Was tut das Plugin?

  • Nodes lesen (Werte, optional historische Werte, Kinder und Eigenschaften) von CoDaBix®.
  • Einen neuen Istwert auf einen spezifizierten Node schreiben.
  • Einen neuen Node anlegen.

z.B. liest die folgende HTTP Anfrage den Nodestruktur Baum von CoDaBix®:

  • Nodes lesen (Werte, optional historische Werte, Kinder und Eigenschaften) von CoDaBix®.
  • Einen neuen Istwert auf einen spezifizierten Node schreiben.
  • Einen neuen Node anlegen.

z.B. liest die folgende HTTP Anfrage den Nodestruktur Baum von CoDaBix®:

CoDaBix-Request.js
var oIE = WScript.CreateObject("InternetExplorer.Application");
oIE.navigate("about:blank");
var token = oIE.Document.Script.prompt("Enter Token", "1:QqjkQAtk4hyWRnbTt1+dZdGFCg3QE+nS");
 
var request;
try {request = new XMLHttpRequest();}
catch (error) {
   try {request = new ActiveXObject("Msxml2.XMLHTTP");}
   catch (error) {
      request = new ActiveXObject("Microsoft.XMLHTTP");
   }
}
 
request.open("POST", "http://localhost:8181/api/json", false);
request.send('{"tk": "' + token + '", "browse": { "na": "" } }');
 
WScript.Echo(request.responseText);

Funktionen

Unterstützte Aktionen für Nodes:

Aktion Beschreibung
Lesen Liest den spezifizierten Node.
Browsen Liest den spezifizierten Node mitsamt Childnodes.
Schreiben Schreibt einen neuen Istwert in den spezifizierten Node.

Unterstützte Aktionen für Nodes:

Aktion Beschreibung
Lesen Liest den spezifizierten Node.
Browsen Liest den spezifizierten Node mitsamt Childnodes.
Schreiben Schreibt einen neuen Istwert in den spezifizierten Node.

Unterstützte Clients

  • HTTP Clients, die HTTP/1.1 sowie das JSON-Format unterstützen

Zweck & Anwendung

  • Einfache Verbingung zu anderen Systemen
  • Einfacher Lese- und Schreibzugriff auf die Nodes von CoDaBix® durch das benutzen einer beliebigen Programmiersprache ohne zusätzliche Bibliotheken
  • Verbinden von CoDaBix® zu existierender RESTable Software (z.B.. SCADA Systeme)
  • Einfache Verbingung zu anderen Systemen
  • Einfacher Lese- und Schreibzugriff auf die Nodes von CoDaBix® durch das benutzen einer beliebigen Programmiersprache ohne zusätzliche Bibliotheken
  • Verbinden von CoDaBix® zu existierender RESTable Software (z.B.. SCADA Systeme)

Dokumentation des RESTful API

Hier finden Sie die Dokumentation der REST API des Plugins:

  • Dokumentation der RESTful API

Hier finden Sie die Dokumentation der REST API des Plugins:

Installation

Das REST Interface Plugin ist ein fester Bestandteil von CoDaBix® und muss nicht installiert werden.

Konfiguration

Das REST Interface Plugin bietet zur Zeit keine Konfigurationsmöglichkeiten an.

Fehlerdiagnose

Das REST Interface Plugin stellt einen Statuscode für Funktionen zu Diagnosezwecken zur Verfügung - siehe Anfrage & Antwort der REST API Documentation.

Das REST Interface Plugin stellt einen Statuscode für Funktionen zu Diagnosezwecken zur Verfügung - siehe Anfrage & Antwort der REST API Documentation.

Entities

Das REST Interface Plugin verwendet das CoDaBix® Entity Modell nicht und stellt daher keine Entities zur Verfügung.

Ordner & Dateien

Das REST Interface Plugin ist ein fester Bestandteil von CoDaBix® und hat deshalb keine zusätzlichen Dateien oder Ordner.

Versionsinformation

Dieses Dokument

Datum 2017-07-12
Version 1.2

Plugin

Name REST Interface Plugin
Version Entspricht der CoDaBix® Version

Assembly

Das REST Interface Plugin ist ein fester Bestandteil von CoDaBix® und hat deshalb keine separate Assembly.