Standard-Web-Schnittstellen für project-pulse-Integration

Da Webschnittstellen kein Vorlagesystem besitzen, können diese Schnittstellen nicht als Vorlage zum Erstellen neuer Webschnitstellen benutzt werden.

Workload - Belastung

• Überträgt die in PLANTA pulse auf Karten erfassten Rückmeldung auf die Vorgänge in PLANTA project

Member - Ressourcenzuordnung

• Überträgt die in PLANTA pulse erfassten Mitgliedszuordnungen als Ressourcenzuordnungen für den entsprechenden Vorgang nach PLANTA project

Zeiterfassung

• Überträgt die in PLANTA pulse auf PLANTA project-Vorgängen erfassten Rückmeldung auf dieselben Vorgänge in PLANTA project

Benutzerbezogene Schnittstellen

Alle benutzerbezogenen Schnittstellen haben in ihrer URL einen Parameter, mit dem die Benutzer-ID aus PLANTA pulse übergeben wird.

Query-Parameter:

GET /pulse/timeTracking/1.0/users/{userID}/postingObjects

Query-Parameter:

Ruft die bebuchbaren Planungsobjekte des Systems für den übergebenen Benutzer ab.

• Die Implementation ist der Funktion "Projekte und Vorgänge für Zeiterfassung hinzufügen" aus dem Standard-Zeiterfassungsmodul nachempfunden:

  • Projekte

    • Nicht gesperrt

    • Kein Ist-Ende

    • Aktiv

  • Vorgänge

    • Nicht gesperrt

    • Kein Ist-Ende

    • Kein Meilenstein

    • Kein Sammelvorgang

    • Nicht nach pulse als Board exportiert

  • Ein Abteilungsfilter existiert im Standard seit DB 13 nicht mehr.

    • Die Schnittstelle kann beim Kunden dann individuell angepasst werden, so wie man auch die Funktion im Zeiterfassungsmodul anpassen würde.

Rückgabewert:

Eine Liste von Planungsobjekten:

Task

GET /pulse/timeTracking/1.0/users/{userID}/attendance

Ruft die Soll-/Ist-Arbeitszeit ab.

• Die Daten sind eine Kombination der Daten aus DT203 (Anwesenheit) und DT468 (Periode).

• Über die optionalen Query-Parameter kann der abgerufene Zeitraum eingeschränkt werden.

Query-Parameter:

Rückgabewert:

Chronologisch sortierter Array von Attendance

Time

AttendanceType Enum

GET /pulse/timeTracking/1.0/users/{userID}/workloads

Ruft die gefilterten Belastungsdatensätze des Benutzers ab. Die Filter:

• Belastung-Ist != 0

• Nicht storniert

• Die Stunden kamen nicht über Hybrid von einer Karte

Query-Parameter:

Rückgabewert:

Eine Liste an Buchungen:

GET /pulse/timeTracking/1.0/users/{userID}/subordinates

Ruft die Ressourcen ab, für die ein gewisser Mitarbeiter buchen darf.

• Es werden nur interne und externe Mitarbeiter ausgegeben, keine Abteilungen (DI 003414 = "1I" OR "1E")

• Wird gesteuert über Zugriff auf Ressourcen

• Es werden nur Ressourcen ausgegeben, die auch mit PLANTA pulse verknüpft sind.

• Der Benutzer, für den abgefragt wird, ist in der Ergebnismenge nicht enthalten.

Rückgabewert:

Ein Array von Resource Objekten

Resource

/pulse/timeTracking/1.0/users/{userID}/bookingFavorite

GET

Wird benutzt, um die Buchungsobjekte zu holen, die in PLANTA project vom übergebenen Benutzer als Favorit markiert sind.

• Es werden nur Daten zu Vorgängen gesendet, die im PLANTA project-Standard im Zeiterfassungsmodul unter "Meine Zeiterfassungsfavoriten" auftauchen würden:

  • Projekt/Vorgang ist nicht gesperrt

  • Projekt ist aktiv

  • Vorgang ist kein Meilenstein

  • Vorgang ist kein Sammelvorgang

  • Ressourcenzuordnung hat kein Ist-Ende

Rückgabewert:

bookingFavorite

POST

Setzt den Favoritenflag auf einer Ressourcenzuordnung.

Parameter:

DELETE

Löscht den Favoritenflag auf einer Ressourcenzuordnung.

Parameter:

Workloads

Die PUT/DELETE-Schnittstellen haben in ihrer URL einen Parameter, mit dem die Belastungs-ID aus PLANTA project übergeben wird.

Workload

Parameter:

Es gibt keine Mussfelder bei PUT (außer die workloadID in der URL natürlich!)

• Es ist nur nötig, die geänderten Felder zu schicken.

• Da in PLANTA project das Verschieben einer Belastung unter ein anderes Projekt / einen anderen Vorgang nicht erlaubt ist, macht es keinen Sinn, die taskUUID zu schicken.

POST /pulse/timeTracking/1.0/workloads

Erstellt eine Belastung (DT472)

Kostenart wird von der Default-Kostenart der Ressource übernommen

Rückgabewert:

/pulse/timeTracking/1.0/workloads/{workloadID}

PUT

Ändert eine Belastung

Rückgabewert:

DELETE

Löscht eine Belastung

Rückgabewert:

POST /pulse/timeTracking/1.0/workloadSearch

Erwartet Body mit mindestens einem der folgenden Parameter als Liste:

Query-Parameter:

Rückgabewert:

Eine Liste an Buchungen:

Aufträge / Kontierungselemente

GET /pulse/timeTracking/1.0/orders

Hiermit können Kontierungselemente zur Buchung zurückgegeben werden. Sobald diese Schnittstelle aktiv ist, werden auf der UI entsprechende Felder freigeschaltet.

Rückgabewert:

Order

OrderPosition

Fehlerbehandlung

Fehler Objekt

HTTP Statuscodes