Zum Hauptinhalt springen
Inhaltsverzeichnis überspringen

Web-Schnittstellen-Bibliothek

Implementationen

Attendance

Informationen

  • Unterstützt GET/POST/PUT/DELETE
  • Ermöglicht die Interaktion mit Attendance-Datensätzen.

AvailableImplementations

Informationen

  • 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

Informationen

  • 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

Informationen

  • Unterstützt GET
  • Leert den Weblink-Cache.

DefaultServiceImplementation

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:47 UTC 2025","trace":null} Informationen

  • Unterstützt GET/POST/PUT/DELETE
  • Stellt alle grundlegenden Web-Schnittstellen-Funktionalitäten bereit.
Siehe auch : Informationen zu den Methoden

GetTransformerParameter

Informationen

  • Unterstützt GET
  • Gibt die Parameter des entsprechenden Transformers zurück.

JiraAssigneeSubscription

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:47 UTC 2025","trace":null} Informationen

  • Unterstützt POST
  • Wird von einem Jira-Webhook aufgerufen, um Ressourcenzuordnungen anzulegen.

JiraWorklogSubscription

Informationen

  • Unterstützt POST
  • Wird von einem Jira-Webhook aufgerufen, um Belastungen anzulegen.

PostingObject

Informationen

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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:48 UTC 2025","trace":null} Details

  • Weiteres Einschränken der Ergebnisse über optionale Parameter möglich:
    • projectsOnly (Boolean)
    • plannedOnly (Boolean)
    • queryText (String)

PulseMemberSubscription

Informationen

  • Unterstützt POST
  • Wird von einer PLANTA pulse-Subscription aufgerufen, um Ressourcenzuordnungen anzulegen.

PulseOrder

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:48 UTC 2025","trace":null} Informationen

  • Unterstützt GET

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Hinweis

  • Im PLANTA-Standard gibt diese Implementation nichts zurück.
  • Sie kann genutzt werden, wenn Buchungen Auftragspositionen enthalten sollen.

PulseTimeTrackingBase

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:48 UTC 2025","trace":null} Informationen

  • Unterstützt GET/POST/PUT/DELETE
  • Erweitert DefaultServiceImplementation für die Interaktion mit PLANTA pulse.

PulseUserBasedBookingFavorites

Informationen

  • Unterstützt GET/POST/DELETE
  • Ermöglicht die Interaktion mit dem Buchungsfavoriten-Flag.

PulseWorkloadSubscription

Informationen

  • Unterstützt POST
  • Wird von einer PLANTA pulse-Subscription aufgerufen, um Belastungen anzulegen.

Subordinate

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:48 UTC 2025","trace":null} Informationen

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

TestImplementation

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

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

UserBasedAttendance

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

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

VersionImplementation

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

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

Workload

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

  • Unterstützt GET
  • Gibt die Belastungen des entsprechenden Benutzers zurück.

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:48 UTC 2025","trace":null} Details

  • Weiteres Einschränken der Ergebnisse über optionale Parameter möglich:
    • startDate (Date)
    • endDate (Date)
    • modifiedSince (Date)
    • modifiedUntil (Date)

WorkloadInterface

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

  • Unterstützt POST/PUT/DELETE
  • Ermöglicht die Interaktion mit Belastungsdatensätzen.

Transformer

ConvertBoardIdToTaskAttribute

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Informationen

  • Erwartet die ID eines Datensatzes aus dem Fremdsystem, der mit PLANTA project verknüpft ist.
  • Gibt den Wert des angegebenen Dataitems zurück.

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:49 UTC 2025","trace":null} Parameter

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Informationen

  • 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.

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Parameter

  • format
    • ist standardmäßig auf '%d.%m.%Y' gesetzt
    • {"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:51 UTC 2025","trace":null} Genauere Beschreibungen zu möglichen Formaten findet man hier.

Decoder

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Information

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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Parameter

  • encoding
    • Encoding des übergebenen Werts.

DefaultCostTypeFromPulseUser

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Informationen

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:51 UTC 2025","trace":null} Informationen

  • Erwartet die ID einer Ressource aus PLANTA project.
  • Gibt die Default-Kostenart der Ressource zurück.

GetResourceViaId

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:50 UTC 2025","trace":null} Informationen

  • Erwartet die ID eines Benutzers aus Jira, der mit PLANTA project verknüpft ist.
  • Gibt die ID der Ressource des Benutzers zurück.

ISO8601Transformer

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Informationen

  • 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.

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Parameter

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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:51 UTC 2025","trace":null} Hinweise

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

JiraDefaultCostTypeFromResource

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Informationen

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Informationen

  • 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.

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Details

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Informationen

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

ProjectFromTask

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:52 UTC 2025","trace":null} Informationen

  • Erwartet die UUID eines Vorgangs in PLANTA project.
  • Gibt die technische Projekt-ID zurück.

PulseDateTransformer

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Informationen

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Informationen

  • 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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Information

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

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Parameter

  • cutoff
    • Ist standardmäßig auf 80 gesetzt.

TaskFromUuid

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Informationen

  • Erwartet die UUID eines Vorgangs in PLANTA project.
  • Gibt die technische Vorgangs-ID zurück.

TextDecoder

siehe "Decoder"

UserToResource

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Informationen

  • Erwartet die UUID eines Benutzers in PLANTA project.
  • Gibt die ID der Ressource des Benutzers zurück.

UserToResourceViaEmail

{"status":500,"error":"Internal Server Error","message":null,"timeStamp":"Fri May 02 11:04:53 UTC 2025","trace":null} Informationen

  • Erwartet die E-Mail-Addresse eines Benutzers in PLANTA project.
  • Gibt die ID der Ressource des Benutzers zurück.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close