REST: Unterschied zwischen den Versionen

Aus OrgaMon Wiki
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
Die REST-Technologie ist in den OrgaMon integriert. Auf einem definierbaren TCP-Port stellt der OrgaMon also einen Web-Service zur Verfügung. Er lässt sich durch einen normalen Web-Browser ansprechen, eigent sich aber insbesondere für die Automatisierung. Oder die Anbindung des WebShops.
Die REST-Server-Technologie ist in den OrgaMon integriert. Auf einem definierbaren TCP-Port (Standard=3047) stellt der OrgaMon also diesen Web-Service zur Verfügung. Er lässt sich durch einen normalen Web-Browser ansprechen, eigent sich aber insbesondere für die Automatisierung und zur Kopplung von anderen Geschäftsprozessen an den OrgaMon. Insbesondere die Anbindung des WebShops.


== root Objekt ==
== Grundlagen der REST Technologie ==


auf Port 3051 wird der Grundeinstieg in den OrgaMon ausgegeben.
* http://www.oio.de/public/xml/rest-webservices.htm
* http://xml-magazin.de/itr/online_artikel/show.php3?id=209&nodeid=69<br>
* http://linuxenterprise.de/itr/news/psecom,id,39097,nodeid,8.html<br>
 
== Beispiele ==
 
# Starten die den REST Service: WebShop->Reiter REST->Schalter REST
# Benutzen Sie einen Browser, und geben Sie den Rechnernamen des Systems an, auf dem sie eben REST gestartet haben.
 
* Beispiel für alle möglichen Datenbank-Tabellen:
 
<code>
http://<RechnerName>:3047/
</code>
 
* Beispiel für eine einzelne Tabelle
 
<code>
http://<RechnerName>:3047/SORTIMENT
</code>
 
== Ausblick ==


voraussichtliche Haupt-Einstiege (r/w):
* Grundsätzliche Erweiterung um einen "Name-Space" genau wie bei XMLRPC, also als erster "Parameter" wird grundsätzlich der Name-Space übertragen.


/olap/<br>
/<NameSpace>/
/buch/<br<


sowie alle Datenbank-Tabellen
* voraussichtliche Haupt-Einstiege (r/w):


/PERSON/<br>
<code>./olap/</code> Ausführen von OLAP-Statements <br>
/BUCH/<br>
<code>./buch/</code> Besondere Auswertungen für die Buchführung <br>
/TICKET/<br>
<code>./shop/</code> Wrapper <br>
<code>./ecommerce/</code> kompletter Funktionsumfang des eCommerce-Moduls<br>


== f - Parameter ==
== f - Parameter ==
Zeile 20: Zeile 41:
Ein allzeit Verwendbarer Parameter für das Format der Antwort des Servers ist der "f"-Parameter. Dabei gibt es folgdende Werte:
Ein allzeit Verwendbarer Parameter für das Format der Antwort des Servers ist der "f"-Parameter. Dabei gibt es folgdende Werte:
   
   
* '''f=xml''': Die Antwort wird in XML formatiert
* '''f=xml''': Die Antwort wird in XML formatiert
* '''f=text''': Die Antwort wird als csv-Tabelle formatiert
* '''f=text''': Die Antwort wird als csv-Tabelle formatiert
* '''f=xls''': Es wird direkt mit einem XLS Dokument geantwortet
* '''f=xls''': Es wird direkt mit einem XLS Dokument geantwortet
* '''f=text.zip''': Die Textantwort wird gezippt übertragen
* '''f=text.zip''': Die Textantwort wird gezippt übertragen
== Links ==
* http://www.oio.de/public/xml/rest-webservices.htm
* http://xml-magazin.de/itr/online_artikel/show.php3?id=209&nodeid=69<br>
* http://linuxenterprise.de/itr/news/psecom,id,39097,nodeid,8.html<br>

Version vom 20. Februar 2008, 09:47 Uhr

Die REST-Server-Technologie ist in den OrgaMon integriert. Auf einem definierbaren TCP-Port (Standard=3047) stellt der OrgaMon also diesen Web-Service zur Verfügung. Er lässt sich durch einen normalen Web-Browser ansprechen, eigent sich aber insbesondere für die Automatisierung und zur Kopplung von anderen Geschäftsprozessen an den OrgaMon. Insbesondere die Anbindung des WebShops.

Grundlagen der REST Technologie

Beispiele

  1. Starten die den REST Service: WebShop->Reiter REST->Schalter REST
  2. Benutzen Sie einen Browser, und geben Sie den Rechnernamen des Systems an, auf dem sie eben REST gestartet haben.
  • Beispiel für alle möglichen Datenbank-Tabellen:

http://<RechnerName>:3047/

  • Beispiel für eine einzelne Tabelle

http://<RechnerName>:3047/SORTIMENT

Ausblick

  • Grundsätzliche Erweiterung um einen "Name-Space" genau wie bei XMLRPC, also als erster "Parameter" wird grundsätzlich der Name-Space übertragen.

/<NameSpace>/

  • voraussichtliche Haupt-Einstiege (r/w):

./olap/ Ausführen von OLAP-Statements
./buch/ Besondere Auswertungen für die Buchführung
./shop/ Wrapper
./ecommerce/ kompletter Funktionsumfang des eCommerce-Moduls

f - Parameter

Ein allzeit Verwendbarer Parameter für das Format der Antwort des Servers ist der "f"-Parameter. Dabei gibt es folgdende Werte:

  • f=xml: Die Antwort wird in XML formatiert
  • f=text: Die Antwort wird als csv-Tabelle formatiert
  • f=xls: Es wird direkt mit einem XLS Dokument geantwortet
  • f=text.zip: Die Textantwort wird gezippt übertragen