Standard Web Interfaces for project-pulse Integration

Since web interfaces do not possess a template system, these interfaces cannot be used as templates for the creation of new web interfaces.

Workload - Load

• Transfers the hours recorded on cards in PLANTA pulse to the tasks in PLANTA project

Member - Resource Assignment

• Copies the member assignments created in PLANTA pulse to PLANTA project as resource assignments for the respective task

Time Recording

• Transfers the hours reported on PLANTA project tasks in PLANTA pulse to the same tasks in PLANTA project

User-Related Interfaces

All user-related interfaces have a parameter in their URL via which the PLANTA pulse user ID is transmitted. Query parameter:

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

Query parameter:

Retrieves the postable planning objects of the system for the transmitted user:

• The implementation is a faithful imitation of the "Add Projects and Tasks for Time Recording" function from the standard time recording module:
  • Projects
    • Not locked
    • No actual end
    • Active
  • Tasks
    • Not locked
    • No actual end
    • No milestone
    • No summary task
    • Not exported to pulse as a board
  • Since DB 13, there is no more department filter in the standard.
    • The interface can then be adjusted individually on the customer’s system, in the same way as the function in the time recording module is adjusted.

Return value: a list of planning objects:

Task

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

Retrieves the planned/actual hours worked.

• The data is a combination of the data from DT203 (presence) and DT468 (period).
• Via the optional query parameter, the period to be retrieved can be restricted.

Query parameters:

Return value: chronologically sorted array of Attendance

Time

AttendanceType Enum

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

Retrieves the filtered load records of the user. The filter:

• Actual load != 0
• Not canceled
• The hours were not imported from a card via hybrid

Query parameters:

Return value: a list of postings:

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

Retrieves the resources for which a particular employee is allowed to make postings.

• Only internal and external employees are displayed, no departments (DI 003414 = "1I" OR "1E")
• Is controlled via Resource Access
• Only resources which are linked to PLANTA pulse are displayed.
• The user for whom the query is made is not included in the result set.

Return value: an array of resource objects resource

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

GET

Is used to fetch the posting objects which have been marked as favorites in PLANTA project by the respective user.

• Only data of tasks is sent which would be displayed in the Time Recording module in PLANTA project standard under "My Time Recording Favorites":
  • Project/task is not locked
  • Project is active
  • Task is no milestone
  • Task is no summary task
  • Resource assignment has no actual end

Return value: bookingFavorite

POST

Sets the favorite flag on a resource assignment. Parameters:

DELETE

Deletes the favorite flag on a resource assignment. Parameters:

Workloads

The PUT/DELETE interfaces have a parameter in their URL which serves to hand over the load ID from PLANTA project.

Workload parameter:

In PUT, there are no mandatory fields (except the workloadID in the URL of course!)

• You only have to send the changed fields.
• Since it is prohibited in PLANTA project to move a load on another project / task, it is useless to send the taskUUID.

POST /pulse/timeTracking/1.0/workloads

Creates a load (DT472) Cost type is copied from the default cost type of the resource Return value:

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

PUT

Changes a load Return value:

DELETE

Deletes a load return value:

Orders / Account Assignment Elements

GET /pulse/timeTracking/1.0/orders

Can be used to return account assignment elements for posting. As soon as this interface is active, respective fields are unlocked on the UI. Return value : Order

OrderPosition

Error Treatment

Error Object

HTTP Status Codes