Die Dokumentation ab Version 39.5.17 von PLANTA project finden Sie in der neuen PLANTA Online-Hilfe

Web-Schnittstellen-Workflow: PUT 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 Projektdaten aktualisiert.

Voraussetzung

Hinweise

Ab DB 39.5.14

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
- generic_service = true
- generic_service_interface und generic_service_port enthalten sinnvolle Daten
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.
NEU Web-Schnittstellen verwenden standardmäßig den Fully Qualified Domain Name (FQDN) als Adresse. Ist dieser nicht verfügbar, wird auf den Hostnamen der Maschine zurückgegriffen. Ist dieser nicht verfügbar, wird auf die IP der Maschine zurückgegriffen. Ein expliziter Hostname kann mit der Globalen Einstellung planta_link_hostname definiert werden.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices in der web.conf aktiviert und konfiguriert sein:
- generic_service = true
- generic_service_interface und generic_service_port enthalten sinnvolle Daten
- Das Makro 009CW6 wurde einmalig ausgeführt und der Dienst neugestartet.
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Um Web-Schnittstellen nutzen zu können, müssen die PLANTA link-Webservices aktiviert und konfiguriert sein:
- generic_service = true
- Die Parameter generic_service_interface und generic_service_port enthalten sinnvolle Daten.
- Das Makro 009CW6 wurde einmalig ausgeführt und der Dienst neugestartet.
Sind die Webservices nicht aktiviert, werden an manchen Stellen die Schaltflächen zur Ausführung verschiedener Aktionen, für die die Webservices erforderlich sind, nicht angezeigt.

Bitte für alle Felder in den Web-Schnittstellen-Modulen Groß-/Kleinschreibung beachten!

Ziel

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 und im Feld Datentabelle die Tabelle 461 auswählen
Über den Kontextmenüeintrag der neu erstellten Web-Entität Einfügen Web-Attribut ein Web-Attribut einfügen:
- DI000690 Projektbezeichnung
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. In diesem Beispiel wird name in das Feld eingetragen.
Speichern

Ziel

Anlegen einer Web-Schnittstelle, die eingehende Requests verarbeitet und das Projekt aktualisiert

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: /project/{project_id}
- Einen API Schlüssel vergeben
- Die PUT-Implementation DefaultServiceImplementation auswählen
- Die aus vorigen Schritt neu erstellte Entität im Feld Web-Entität auswählen
Nach Auswahl der Entität kann mit einem Klick auf den Werkzeug-Button der URL-Filter konfiguriert werden
- Im Dialogmodul das Dataitem 041317 "Projekt" wählen
- Hinweis: Hierbei handelt es sich um die fachliche ID, nicht die technische.

Ziel

Vorgehensweise

Durch Betätigen des Buttons mit der Erde öffnet sich das Modul Web-Schnittstelle testen
Als HTTP-Methode PUT auswählen
Auf die Abfrage, ob eine Vorlage einkopiert werden soll, die Schaltfläche Ja betätigen
Für den URL-Filter wird das Projekt "4711" konfiguriert.
Das einkopierte Template wie folgt füllen:
- {"name": "Beispieltext"}
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
Wenn der Statuscode 200 angezeigt wird, dann war die Abfrage erfolgreich und das Projekt 4711 trägt den neuen Titel "Beispieltext"

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

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

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

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

PLANTA project

PLANTA pulse

PLANTA project