Web-Schnittstellen-Workflow: GET Neu ab DB 39.5.10

Informationen

• Der nachfolgende Workflow vermittelt das Basiswissen, um eine Web-Schnittstelle in PLANTA project mit den mitgelieferten Funktionen zu erstellen.
• Das Ziel dieses Workflows ist eine Web-Schnittstelle, die Belastungsdaten zur Verfügung stellt.

Voraussetzung

• Grundlegendes Customizing-Wissen
• Grundlegendes Wissen über REST

Hinweise

Web-Entität anlegen

Ziel

• Anlegen einer Web-Entität, die unsere Daten beschreibt

Vorgehensweise

• Das Panel Konfiguration öffnen
• Im Untermodul Web-Entitäten eine neue Entität einfügen
  • Über den Kontextmenüeintrag Einfügen Web-Entität oder
  • Klick auf den Button Einfügen
• Bezeichnung vergeben und im Feld Datentabelle die Tabelle 472 auswählen
• Über den Kontextmenüeintrag der neu erstellten Web-Entität Einfügen Web-Attribut vier Web-Attribute einfügen:
  • DI001395 Projekt-ID
  • DI001516 Vorgangs-ID
  • DI001519 Belastungsdatum
  • DI001510 Belastung-Ist
• Die Spaltentypen werden automatisch ausgelesen und angezeigt.
• Die Bezeichnung des Attributs im Feld Name ist frei wählbar, muss jedoch den Java-Namenskonventionen für Bezeichner folgen und darf innerhalb einer Entität nicht mehrfach vorkommen.
• Für das Belastungsdatum wird im Feld Transformer automatisch DateTransformer ausgewählt.
  • Durch Klick auf das Werkzeugsymbol können die Parameter des Transformers angepasst werden.
    • Der DateTransformer erlaubt es, das Datumsformat zu konfigurieren.
• Speichern

Web-Schnittstelle anlegen

Ziel

• Anlegen einer Web-Schnittstelle, die die Daten bereitstellt

Vorgehensweise

• Das Panel Konfiguration öffnen
• Eine neue Web-Schnittstelle anlegen
  • Über den Kontextmenüeintrag Einfügen Web-Schnittstelle oder
  • Klick auf den Button Einfügen
• Felder wie folgt ausfüllen:
  • Die Bezeichnung ist frei wählbar
  • Das Feld Aktiv muss aktiviert werden, bevor die Schnittstelle eingesetzt wird.
  • Im Feld Url einen Platzhalter anlegen, beispielsweise: /load/{resource}
  • Einen API Schlüssel vergeben
  • Die GET-Implementation DefaultServiceImplementation auswählen
  • Die aus vorigen Schritt neu erstellte Entität im Feld Web-Entität auswählen
• Speichern
• Nach Auswahl der Entität kann mit einem Klick auf den Werkzeug-Button der URL-Filter konfiguriert werden
  • Im Dialogmodul das Dataitem 001517 Ressource wählen und speichern

Web-Schnittstelle testen

Ziel

• Die neu angelegte Web-Schnittstelle testen

Vorgehensweise

• Durch Betätigen des Pfeil-Buttons (rechts neben "Komplette URL") öffnet sich das Modul Web-Schnittstelle testen
• Als HTTP-Methode GET auswählen
• Als Ressource R1 eintragen
• Den Button Ausführen betätigen
  • Der Platzhalter in der URL wird automatisch mit dem übergebenen Wert ersetzt und der API Schlüssel im HTTP Header mitgegeben
• Im Feld Response wird das Ergebnis der Abfrage, das nach 3000 Zeichen abgeschnitten wird, ausgegeben.

Beispiel Rückgabewert:

[{"date": "13.10.2016", "prId": "7000", "load": 8.0, "taskId": "1.01"}, {"date": "14.10.2016", "prId": "7000", "load": 10.0, "taskId": "1.01"}, {"date": "17.10.2016", "prId": "7000", "load": 3.0, "taskId": "1.01"}, {"date": "30.09.2016", "prId": "7000", "load": 7.0, "taskId": "1.01"}, {"date": "03.10.2016", "prId": "7000", "load": 7.0, "taskId": "1.01"}, {"date": "24.11.2016", "prId": "7000", "load": 8.0, "taskId": "3.10"}]

---

Siehe auch: Web-Schnittstellen-Workflows: PUT, POST, DELETE

---

Siehe auch: Hier finden Sie einen Überblick über alle PLANTA link-Inhalte