Web-Schnittstellen-Workflow: POST 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 neue Vorgänge anlegt

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 463 auswählen
• Über den Kontextmenüeintrag der neu erstellten Web-Entität Einfügen Web-Attribut drei Web-Attribute einfügen:
  • DI001097 Projekt-ID mit der Bezeichnung project
  • DI000807 Vorgangsbezeichnung mit der Bezeichnung name
  • DI008851 ID übergeordneter Vorgang mit der Bezeichnung parent
• Speichern

Web-Schnittstelle anlegen

Ziel

• Anlegen einer Web-Schnittstelle, welche eingehende Requests verarbeitet und unsere Vorgänge anlegt

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: /task
  • Einen API Schlüssel vergeben
  • Die POST-Implementation DefaultServiceImplementation auswählen
  • Die aus vorigen Schritt neu erstellte Entität im Feld Web-Entität auswählen

Web-Schnittstelle testen

Ziel

• Die neu angelegte Web-Schnittstelle testen

Vorgehensweise

• Durch Betätigen des Buttons öffnet sich das Modul Web-Schnittstelle testen
• Als HTTP-Methode POST auswählen
• Auf die Abfrage, ob eine Vorlage einkopiert werden soll, die Schaltfläche Ja betätigen
• Für den URL-Filter das Projekt 4711 konfigurieren
  • Um den Datensatz korrekt anzulegen, muss die technische ID des Projektes ermittelt werden. In diesem Fall: 000008.
• Das einkopierte Template wie folgt füllen:
  • {"project": "000008", "name": "Sammelvorgang", "parent": ""}
• 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.
• Als Antwort auf eine erfolgreiche Abfrage antwortet der Server mit den Autonummern des angelegten Datensatzes wie folgt:
  • {"task_id": "12"}
• Die ID kann für eine erneute Abfrage mit dem folgenden Request verwendet werden:
  • {"project": "000008", "name": "Vorgang", "parent": "12"}
• Wird nun der Terminplan des Projektes geöffnet, befinden sich dort zwei neue strukturierte Vorgänge.

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

---

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