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:

NameMussfeldDatentypFormat
userIDXStringPulse-ID des Benutzers

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

Query-Parameter :

NameMussfeldDatentypFormat
plannedOnly
StringWird für plannedOnly der Wert "true" (Groß-/Kleinschreibung irrelevant) übergeben, dann werden nur die Buchungsobjekte zurückgegeben, auf die der Benutzer eingeplant ist.
queryText
StringErlaubt die Übergabe eines Strings, um die Ergebnisse einzuschränken. Implementierung basiert auf der pulse Such-Implementation. Beispiel: projectId:4711 Konzept
projectsOnly
StringWird für projectsOnly der Wert "true" (Groß-/Kleinschreibung irrelevant) übergeben, dann werden in dem Resultat keine Vorgänge ausgegeben.

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:

NameDatentypBeschreibung
projectUUIDStringUUID des Projekts in PLANTA project (DI 060934)
functionalIDStringFachliche ID des Projekts (DI 041317)
nameStringProjektbezeichnung (DI 023655)
keyDateStringGlobaler Stichtag (DI 000132).
Wird hier für alle Projekte ausgegeben, um später auf PLANTA project-Seite einfach Anpassungen zu machen, um die bebuchbaren Objekte einzuschränken.
Format: yyyy-mm-dd oder leer
tasksArrayArray von Task Objekten

Task

NameDatatypBeschreibung
UUIDStringUUID des Vorgangs in PLANTA project (DI 060936)
functionalIDStringFachliche ID des Vorgangs (DI 041467). Wenn diese leer ist, dann die technische ID (DI 001098)
nameStringVorgangsbezeichnung (DI 000807)
plannedBooleanGibt an, ob der Benutzer als Ressource in diesem Vorgang eingeplant ist

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 :

NameMussfeldDatentypFormat
startDate
Stringyyyy-mm-dd
endDate
Stringyyyy-mm-dd

Rückgabewert : Chronologisch sortierter Array von Attendance

NameDatentypBeschreibung
periodUUIDStringUUID aus der DT468 (DI 060941)
unitPerPeriodFloatSoll-Arbeitszeit an diesem Tag (DI 001339)
availCapFloatVerfügbare Kapazität an diesem Tag (Soll * Faktoren) (DI 001337)
vacationFloatAnzahl Stunden Urlaub an diesem Tag (DI 001340 umgerechnet)
absenceFloatAnzahl Stunden Abwesenheit an diesem Tag (DI 001341 umgerechnet)
dateStringDatum im Format yyyy-mm-dd (DI 001327)
timeArrayArray von Time Objekten

Time

NameDatentypBeschreibung
attendanceUUIDStringUUID aus der DT203 (DI 065304)
typeStringEin Kenner aus dem AttendanceType enum (DI 065317)
durationFloatDauer in Stunden (DI 065320)
startTimeUhrzeitStart der Zeitscheibe (DI 065318)
endTimeUhrzeitEnde der Zeitscheibe (DI 065319)
commentStringKommentar (DI 065321)

AttendanceType Enum

SchlüsselBeschreibung
attendanceAnwesenheit
breakPause
travel_billableFahrzeit (Arbeitszeit)
travel_timeFahrzeit (keine Arbeitszeit)
travel1 Fahrt
overnight_stay1 Übernachtung
unknownUnbekannter Wert

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 :

NameMussfeldDatentypFormat
startDate
Stringyyyy-mm-dd
endDate
Stringyyyy-mm-dd
modifiedSince
Stringyyyy-mm-dd
modifiedUntil
Stringyyyy-mm-dd

Rückgabewert Eine Liste an Buchungen:

NameDatentypBeschreibung
taskUUIDStringUUID des Vorgangs in PLANTA project (DI 060936)
taskNameStringVorgangsbezeichnung in PLANTA project (DI 000807)
taskFunctionalIDStringFachliche ID des Vorgangs (DI 041467). Wenn diese leer ist, dann die technische ID (DI 001098)
bookingPossibleBooleanBildet die Filter ab, die in PLANTA project den Bereich "Nicht bebuchbare Objekte" ausmachen (Projekt/Vorgang gesperrt, Projekt inaktiv oder Ressourcenzuordnung hat Ist-Ende)
projectUUIDStringUUID des Projekts in PLANTA project (DI 060934)
projectFunctionalIDStringFachliche ID des Projekts (DI 041317)
projectNameStringProjektbezeichnung in PLANTA project (DI 000690)
loadNumberBelastung als Zahl (DI 001510)
dateStringDatum im Format YYYY-MM-DD (DI 001519)
commentStringKommentar (DI 001438)
orderStringAuftrag (DI 027646)
orderItemNumberAuftragsposition (DI 027647)
loadUUIDStringUUID der Belastung in PLANTA project (DI 060945)
created_onStringAnlagedatum im Format YYYY-MM-DD (DI 001500)
modified_onStringÄnderungsdatum im Format YYYY-MM-DD (DI 001501)
created_byStringAnlagebenutzer (DI 001503)
modified_byStringÄnderungsbenutzer (DI 001504)
keyDateStringGlobaler Stichtag (DI 000132).
Wird hier für alle Projekte ausgegeben, um später auf PLANTA project-Seite einfach Anpassungen zu machen, um die bebuchbaren Objekte einzuschränken.
Format: yyyy-mm-dd oder leer

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

NameDatentypBeschreibung
resourceUUIDStringPLANTA pulse-ID des Benutzers
resourceNameStringName der Ressource (DI 001275)
resourceTypeString1I für Interner Mitarbeiter, 1E für Externer Mitarbeiter

/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

NameDatentypBeschreibung
taskUUIDStringUUID des Vorgangs in PLANTA project (DI 060936)
taskFunctionalIDStringFachliche ID des Vorgangs (DI 041467). Wenn diese leer ist die technische ID (DI 001098)
taskNameStringVorgangsbezeichnung in PLANTA project (DI 000807)
projectUUIDStringUUID des Projekts in PLANTA project (DI 060934)
projectFunctionalIDStringFachliche ID des Projekts (DI 041317)
projectNameStringProjektbezeichnung in PLANTA project (DI 000690)
keyDateStringGlobaler Stichtag (DI 000132)
Format: yyyy-mm-dd oder leer

POST

Setzt den Favoritenflag auf einer Ressourcenzuordnung. Parameter:

NameMussfeldDatentypBeschreibung
taskUUIDxStringUUID des Vorgangs in PLANTA project (DI 060936)

DELETE

Löscht den Favoritenflag auf einer Ressourcenzuordnung. Parameter:

NameMussfeldDatentypBeschreibung
taskUUIDxStringUUID des Vorgangs in PLANTA project (DI 060936)

Workloads

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

NameMussfeldDatentypFormat
workloadIDXStringUUID der Belastung (DI 060945)

Workload Parameter:

NameMussfeld bei POSTDatentypBeschreibung
taskUUIDxStringUUID des Vorgangs in PLANTA project (DI 060936)
userIDxStringPLANTA pulse-ID des Benutzers
loadxNumberBelastung (DI 001510)
commentxStringKommentar (DI 001438)
datexStringBelastungsdatum (DI 001519) im Format yyyy-MM-dd'T'HH:mm:ss.SSSZ
order
StringAuftrag (DI 027646)
orderItem
NumberAuftragsposition (DI 027647)

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:

NameDatentypBeschreibung
UUIDStringUUID der Belastung
taskUUIDStringUUID des Vorgangs in PLANTA project (DI 060936)
userIDStringPLANTA project-ID des Benutzers
loadNumberBelastung (DI 001510)
commentStringKommentar (DI 001438)
dateStringBelastungsdatum (DI 001519) (Format ist zurzeit nicht definiert)

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

PUT

Ändert eine Belastung Rückgabewert:

NameDatentypBeschreibung
UUIDStringUUID der Belastung
taskUUIDStringUUID des Vorgangs in PLANTA project (DI 060936)
loadNumberBelastung (DI 001510)
commentStringKommentar (DI 001438)
dateStringBelastungsdatum (DI 001519) (Format ist zurzeit nicht definiert)

DELETE

Löscht eine Belastung Rückgabewert:

NameDatentypBeschreibung
UUIDStringUUID der Belastung

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

NameDatentypBeschreibung
orderIdStringIdentifier
orderNameStringBezeichnung
orderItemsArray<OrderPosition>Auftragspositionen

OrderPosition

NameDatentypBeschreibung
posIdNumberIdentifier
posNameStringBezeichnung

Fehlerbehandlung

Fehler Objekt

NameDatentypBeschreibung
statusCodeNumberHTTP Statuscode
messageStringFehler Nachricht
detailsStringz.B. Stacktrace
type (opt.)StringBei PLANTA pulse: PLANTA project-Request

HTTP Statuscodes

Status CodeDescription
200Returned when successful
400Bad Request
401Forbidden
403Returned when the user is not authorized
404Returned when no endpoint exists at the given address
500Internal Server Error