Web-Schnittstellen-Bibliothek

Implementationen

Attendance

• Unterstützt GET/POST/PUT/DELETE

• Ermöglicht die Interaktion mit Attendance-Datensätzen.

AvailableImplementations

• Unterstützt GET

• Gibt ein Dictionary zurück mit den Schlüsseln 'PLANTA' und 'Customer', die als Wert jeweils eine Liste an verfügbaren Implementationen haben.

AvailableTransformers

• Unterstützt GET

• Gibt ein Dictionary zurück mit den Schlüsseln 'PLANTA' und 'Customer', die als Wert jeweils eine Liste an verfügbaren Transformern haben.

CacheClear

• Unterstützt GET

• Leert den Weblink-Cache.

DefaultServiceImplementation

• Unterstützt GET/POST/PUT/DELETE

• Stellt alle grundlegenden Web-Schnittstellen-Funktionalitäten bereit.

Siehe auch: Informationen zu den Methoden

GetTransformerParameter

• Unterstützt GET

• Gibt die Parameter des entsprechenden Transformers zurück.

JiraAssigneeSubscription

• Unterstützt POST

• Wird von einem Jira-Webhook aufgerufen, um Ressourcenzuordnungen anzulegen.

JiraWorklogSubscription

• Unterstützt POST

• Wird von einem Jira-Webhook aufgerufen, um Belastungen anzulegen.

Milestones

• Unterstützt POST

• Erwartet eine Liste mit Projekt-IDs.

• Gibt die Auflistung aller Meilensteine pro Projekt zurück (einschließlich eines HTML-Textes zur Verwendung als Beschreibung von Kalenderereignissen) und zeigt an, ob jeweiliges Projekt noch existiert.

ModuleReaderImplementation

• Unterstützt GET

• Über diesen Endpunkt kann ein in PLANTA project freigegebenes Modul übers Web ausgelesen werden.

  • Die Query Parameter werden an die Modulklasse weitergegeben. Standardmäßig bekommt man die Daten zu einem Modul als JSON. Übergibt man “format=json-schema", bekommt man eine JSON-Schema Datei zum Modul, statt den Moduldaten.

• Am Endpunkt wird sich über einen API-Token authentifiziert (Hinweis: im Standard wird für diesen Endpunkt kein API-Token mitgeliefert, dieser muss kundenseitig erstellt werden.

• Die Implementation prüft, ob das angeforderte Modul fürs Web freigegeben ist. Wenn ja, wird es über ein Makromodul (009DVH) in einer PLSYSTEM-Session geöffnet und die read_module_data_for_web() Methode aufgerufen.

PostingObject

• Unterstützt GET

• Gibt Projekte und Vorgänge zurück, auf die der entsprechende Benutzer buchen darf.

• Weiteres Einschränken der Ergebnisse über optionale Parameter möglich:

  • projectsOnly (Boolean)

  • plannedOnly (Boolean)

  • queryText (String)

PulseMemberSubscription

• Unterstützt POST

• Wird von einer PLANTA pulse-Subscription aufgerufen, um Ressourcenzuordnungen anzulegen.

PulseOrder

• Unterstützt GET

• Im PLANTA-Standard gibt diese Implementation nichts zurück.

• Sie kann genutzt werden, wenn Buchungen Auftragspositionen enthalten sollen.

PulseTimeTrackingBase

• Unterstützt GET/POST/PUT/DELETE

• Erweitert DefaultServiceImplementation für die Interaktion mit PLANTA pulse.

PulseUserBasedBookingFavorites

• Unterstützt GET/POST/DELETE

• Ermöglicht die Interaktion mit dem Buchungsfavoriten-Flag.

PulseWorkloadSubscription

• Unterstützt POST

• Wird von einer PLANTA pulse-Subscription aufgerufen, um Belastungen anzulegen.

Subordinate

• Unterstützt GET

• Gibt die untergeordnete Ressourcenstruktur der übergebenen Ressource zurück.

TestImplementation

• Unterstützt GET/POST/PUT/DELETE

• Dummyklasse mit nicht implementierten GET-/POST-/PUT-/DELETE-Methoden

UserBasedAttendance

• Unterstützt GET

• Gibt die Perioden sowie etwaige untergeordnete Anwesenheiten des entsprechenden Benutzers zurück.

VersionImplementation

• Unterstützt GET

• Gibt die Lizenz und die Customizing-Version des Systems zurück.

Workload

• Unterstützt GET

• Gibt die Belastungen des entsprechenden Benutzers zurück.

• Weiteres Einschränken der Ergebnisse über optionale Parameter möglich:

  • startDate (Date)

  • endDate (Date)

  • modifiedSince (Date)

  • modifiedUntil (Date)

WorkloadInterface

• Unterstützt POST/PUT/DELETE

• Ermöglicht die Interaktion mit Belastungsdatensätzen.

Transformer

ConvertBoardIdToTaskAttribute

• Erwartet die ID eines Datensatzes aus dem Fremdsystem, der mit PLANTA project verknüpft ist.

• Gibt den Wert des angegebenen Dataitems zurück.

• task_python_id

  • Python-ID des Dataitems, das von dem Vorgang ausgelesen werden soll.

• external_system_identifier

  • Kenner des externen Systems (729 für Jira oder 728 für PLANTA pulse).

DateTransformer

• Gibt bei GET das PLANTA Datum als String im angegebenen Format zurück.

• Erwartet bei POST/PUT ein Datum als String im angegebenen Format, das in das interne PLANTA Format umgewandelt wird.

• Kann nur auf Datumsfeldern eingesetzt werden.

• format

  • ist standardmäßig auf '%d.%m.%Y' gesetzt

  • Error rendering macro 'fontawesome-macro' : Page loading failed
    Genauere Beschreibungen zu möglichen Formaten findet man hier.

Decoder

• Dekodiert den übergebenen Wert mit dem angegebenen Encoding und gibt ihn zurück.

• encoding

  • Encoding des übergebenen Werts.

DefaultCostTypeFromPulseUser

• Erwartet die ID eines Benutzers aus PLANTA pulse, der mit PLANTA project verknüpft ist.

• Gibt die Default-Kostenart der Ressource des Benutzers zurück.

DefaultCostTypeFromResource

• Erwartet die ID einer Ressource aus PLANTA project.

• Gibt die Default-Kostenart der Ressource zurück.

GetResourceViaId

• Erwartet die ID eines Benutzers aus Jira, der mit PLANTA project verknüpft ist.

• Gibt die ID der Ressource des Benutzers zurück.

ISO8601Transformer

• Gibt bei GET das PLANTA Datum + Uhrzeit der entsprechenden Zeile im ISO 8601-Format zurück.

• Erwartet bei POST/PUT ein Datum im ISO 8601-Format, das in das interne PLANTA Format umgewandelt wird.

• date

  • Muss per relativem Parameter auf ein Datumsfeld zeigen, um den Tag bei GET korrekt zu berechnen.

• Wird der Transformer nur für schreibenden Zugriff benutzt, muss der date-Parameter nicht gefüllt werden.

• Funktioniert nur auf Uhrzeitfeldern.

JiraDefaultCostTypeFromResource

• Erwartet die ID eines Benutzers aus Jira, der mit PLANTA project verknüpft ist.

• Gibt die Default-Kostenart der Ressource des Benutzers zurück.

ListboxValueToCategoryTransformer

• Mit dem Transformer können Endpunkte gebaut werden, die mit besser lesbaren Werten arbeiten als den PLANTA Listboxwerten.

  • Ein Beispiel für die Implementierung findet sich in der "Pulse: Attendance"-Entität, wo der Anwesenheitstyp in einem lesbaren Text kommuniziert wird.

• Der Parameter listbox_category muss auf eine gültige Listboxkategorie gesetzt werden.

• Der Transformer wandelt dann zwischen den Werten in den Dataitems LBVAL und Kategorie (DT447 Listboxwerte) um.

LoadFromTimeSpentSeconds

• Erwartet einen Wert in Sekunden.

• Gibt den Wert in Stunden als float zurück.

ProjectFromTask

• Erwartet die UUID eines Vorgangs in PLANTA project.

• Gibt die technische Projekt-ID zurück.

PulseDateTransformer

• Gibt bei GET das PLANTA-Datum als String im Format yyyy-MM-dd zurück.

• Erwartet bei POST/PUT ein Datum als String im Format yyyy-MM-dd, das in das interne PLANTA Format umgewandelt wird.

• Funktioniert nur auf Datumsfeldern.

PulseUserIdToPLANTAUser

• Gibt bei GET die ID des PLANTA pulse-Benutzers zurück, der mit dem angegebenen PLANTA project-Benutzer verknüpft ist.

• Gibt bei POST/PUT die ID des PLANTA project-Benutzers zurück, der mit dem angegebenen PLANTA pulse-Benutzer verknüpft ist.

Slicer

• Gibt den übergebenen Wert, nach der dem Parameter entsprechenden Anzahl Zeichen abgeschnitten, zurück.

• cutoff

  • Ist standardmäßig auf 80 gesetzt.

TaskFromUuid

• Erwartet die UUID eines Vorgangs in PLANTA project.

• Gibt die technische Vorgangs-ID zurück.

TextDecoder

siehe "Decoder"

UserToResource

• Erwartet die UUID eines Benutzers in PLANTA project.

• Gibt die ID der Ressource des Benutzers zurück.

UserToResourceViaEmail

• Erwartet die E-Mail-Adresse eines Benutzers in PLANTA project.

• Gibt die ID der Ressource des Benutzers zurück.