Resource Access: Unterschied zwischen den Versionen

Aus ARTECO Wiki
Zur Navigation springen Zur Suche springen
K (Die Seite wurde neu angelegt: „Diese Seite beschreibt den Zugriff auf Resourcen. Das hier aufgelistete gilt im Allgemeinen für alle verfügbaren Resourcen.“)
 
 
(23 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
Diese Seite beschreibt den Zugriff auf Resourcen. Das hier aufgelistete gilt im Allgemeinen für alle verfügbaren [[:Category:WebserviceResources|Resourcen]].
+
Diese Seite beschreibt den Zugriff auf [[:Category:WebserviceResources|Ressourcen]]. Das hier Beschriebene gilt im Allgemeinen für alle verfügbaren [[:Category:WebserviceResources|Ressourcen]].
 +
 
 +
Um Zugriff auf [[:Category:WebserviceResources|Ressourcen]] zu erhalten benötigt man einen [[Users|Benutzeraccount]]. Hier gibt's Informationen zur [[Login|Authentifizierung]].
 +
 
 +
== Liste von Ressourcen abfragen ==
 +
 
 +
=== HTTP Befehl ===
 +
GET /<resource name in plural>.xml
 +
 
 +
=== Beispiel ===
 +
Aufruf der Liste aller [[Systems|Systeme]]
 +
https://xml.arteco.de/systems.xml
 +
 
 +
liefert eine Antwort wie diese
 +
<systems>
 +
  <system>
 +
  ...
 +
  </system>
 +
  <system>
 +
  ...
 +
  </system>
 +
</systems>
 +
 
 +
== Eine einzelne Ressource abfragen ==
 +
Auf diese Art und Weise kann man die Daten einer einzelnen Ressource abfragen. Im allgemeinen wird eine Ressource über ihre [[UUIDs|UUID]] spezifiziert.
 +
 
 +
=== HTTP Befehle ===
 +
GET /<resource name in plural>/<uuid der ressource>.xml
 +
 
 +
=== Beispiel ===
 +
Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A
 +
https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
 +
 
 +
== Eine neue Ressource erstellen ==
 +
=== HTTP Befehl ===
 +
POST /systems.xml
 +
 
 +
=== Beispiel ===
 +
Ein POST an
 +
https://xml.arteco.de/systems.xml
 +
 
 +
mit folgendem Inhalt
 +
<system>
 +
  <name>Mein Auto</name>
 +
</system>
 +
 
 +
erstellt ein System mit dem Namen "Mein Auto". Siehe auch [[HTTP Post per Telnet]].
 +
 
 +
Als Antwort liefert der Server das soeben erstelle System inclusive auf dem Server generierter Daten (wie z.B. der [[UUIDs|UUID]]) zurück.
 +
<system>
 +
  <name>Mein Auto</name>
 +
  <short-name></short-name>
 +
  <created-at type="datetime">2009-06-19T10:34:06Z</created-at>
 +
  <updated-at type="datetime">2009-06-19T10:34:06Z</updated-at>
 +
  <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid>
 +
  <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid>
 +
  ...
 +
</system>
 +
 
 +
== Eine vorhandene Ressource aktualisieren ==
 +
 
 +
=== HTTP Befehl ===
 +
PUT /<resource name in plural>/<uuid der ressource>.xml
 +
 
 +
=== Beispiel ===
 +
Ein PUT an
 +
https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
 +
 
 +
mit folgendem Inhalt
 +
<system>
 +
  <name>Mein tolles Auto</name>
 +
</system>
 +
 
 +
ändert den Namen des [[Systems]] mit der [[UUIDs|UUID]] AC87BDDF-E44C-43CC-9134-A2285A18C30A auf "Mein tolles Auto". Der Server liefert, wie auch beim Erstellen eines [[Systems]], das XML Dokument zurück:
 +
 
 +
<system>
 +
  <name>Mein tolles Auto</name>
 +
  <short-name></short-name>
 +
  <created-at type="datetime">2009-06-19T10:34:06Z</created-at>
 +
  <updated-at type="datetime">2009-06-19T12:01:18Z</updated-at>
 +
  <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid>
 +
  <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid>
 +
  ...
 +
</system>
 +
 
 +
Siehe auch [[HTTP Post per Telnet]].
 +
 
 +
== Eine vorhandene Ressource löschen ==
 +
 
 +
=== HTTP Befehl ===
 +
DELETE /<resource name in plural>/<uuid der ressource>.xml
 +
 
 +
=== Beispiel ===
 +
Ein DELETE an
 +
https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml
 +
 
 +
löscht das [[Systems|System]] mit der [[UUIDs|UUID]] AC87BDDF-E44C-43CC-9134-A2285A18C30A.
 +
 
 +
== Abfrage Parameter ==
 +
Beim Abfragen von Listen und einzelnen [[:Category:WebserviceResources|Ressourcen]] können [[:Category:UrlParameters|Parameter]] mit der URL übergeben werden. Auf den Seiten der [[:Category:WebserviceResources|Ressourcen]] ist dokumentiert, welche [[:Category:UrlParameters|Parameter]] unterstützt werden.

Aktuelle Version vom 8. Oktober 2012, 13:53 Uhr

Diese Seite beschreibt den Zugriff auf Ressourcen. Das hier Beschriebene gilt im Allgemeinen für alle verfügbaren Ressourcen.

Um Zugriff auf Ressourcen zu erhalten benötigt man einen Benutzeraccount. Hier gibt's Informationen zur Authentifizierung.

Liste von Ressourcen abfragen

HTTP Befehl

GET /<resource name in plural>.xml

Beispiel

Aufruf der Liste aller Systeme 

https://xml.arteco.de/systems.xml

liefert eine Antwort wie diese 

<systems>
 <system>
  ... 
 </system>
 <system>
  ... 
 </system>
</systems>

Eine einzelne Ressource abfragen

Auf diese Art und Weise kann man die Daten einer einzelnen Ressource abfragen. Im allgemeinen wird eine Ressource über ihre UUID spezifiziert.

HTTP Befehle

GET /<resource name in plural>/<uuid der ressource>.xml

Beispiel

Aufruf des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A 

https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml

Eine neue Ressource erstellen

HTTP Befehl

POST /systems.xml

Beispiel

Ein POST an 

https://xml.arteco.de/systems.xml

mit folgendem Inhalt 

<system> 
 <name>Mein Auto</name> 
</system>

erstellt ein System mit dem Namen "Mein Auto". Siehe auch HTTP Post per Telnet.

Als Antwort liefert der Server das soeben erstelle System inclusive auf dem Server generierter Daten (wie z.B. der UUID) zurück. 

<system> 
 <name>Mein Auto</name> 
 <short-name></short-name> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <updated-at type="datetime">2009-06-19T10:34:06Z</updated-at> 
 <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid> 
 <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid> 
 ...
</system>

Eine vorhandene Ressource aktualisieren

HTTP Befehl

PUT /<resource name in plural>/<uuid der ressource>.xml

Beispiel

Ein PUT an 

https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml

mit folgendem Inhalt 

<system> 
 <name>Mein tolles Auto</name> 
</system>

ändert den Namen des Systems mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A auf "Mein tolles Auto". Der Server liefert, wie auch beim Erstellen eines Systems, das XML Dokument zurück: 

<system> 
 <name>Mein tolles Auto</name> 
 <short-name></short-name> 
 <created-at type="datetime">2009-06-19T10:34:06Z</created-at> 
 <updated-at type="datetime">2009-06-19T12:01:18Z</updated-at> 
 <uuid>AC87BDDF-E44C-43CC-9134-A2285A18C30A</uuid> 
 <customer-uuid>2BE6327F-6F47-487A-B3EE-28FC3BEC50CC</customer-uuid> 
 ...
</system>

Siehe auch HTTP Post per Telnet.

Eine vorhandene Ressource löschen

HTTP Befehl

DELETE /<resource name in plural>/<uuid der ressource>.xml

Beispiel

Ein DELETE an 

https://xml.arteco.de/systems/AC87BDDF-E44C-43CC-9134-A2285A18C30A.xml

löscht das System mit der UUID AC87BDDF-E44C-43CC-9134-A2285A18C30A.

Abfrage Parameter

Beim Abfragen von Listen und einzelnen Ressourcen können Parameter mit der URL übergeben werden. Auf den Seiten der Ressourcen ist dokumentiert, welche Parameter unterstützt werden.

Abgerufen von „https://wiki.arteco.de/index.php?title=Resource_Access&oldid=1823“