Skip to main content
Skip table of contents

Web Interface Library

Implementations

Attendance

Information

  • Supports GET/POST/PUT/DELETE

  • Enables interaction with attendance records.

AvailableImplementations

Information

  • Supports GET

  • Returns a dictionary with the ‘PLANTA’ and ‘Customer’ keys which each have a list of available implementations as a value.

AvailableTransformers

Information

  • Supports GET

  • Returns a dictionary with the ‘PLANTA’ and ‘Customer’ keys which each have a list of available transformers as a value.

CacheClear

Information

  • Supports GET

  • Clears the weblink cache.

DefaultServiceImplementation

Information

  • Supports GET/POST/PUT/DELETE

  • Makes all basic web interface functionalities available.

See also: Information on Methods

GetTransformerParameter

Information

  • Supports GET

  • Returns the parameters of the respective transformer.

JiraAssigneeSubscription

Information

  • Supports POST

  • Is opened by a Jira webhook to create resource assignments.

JiraWorklogSubscription

Information

  • Supports POST

  • Is opened by a Jira webhook to create loads.

PostingObject

Information

  • Supports GET

  • Returns projects and tasks to which the respective user is allowed to post.

Details

  • The results can further be restricted via optional parameters:

    • projectsOnly (Boolean)

    • plannedOnly (Boolean)

    • queryText (String)

PulseMemberSubscription

Information

  • Supports POST

  • Is opened by a PLANTA pulse subscription to create resource assignments.

PulseOrder

Information

  • Supports GET

Note

  • In PLANTA standard, this implementation does not return anything.

  • It can be used if postings are to contain order items.

PulseTimeTrackingBase

Information

  • Supports GET/POST/PUT/DELETE

  • Extends DefaultServiceImplementation for interaction with PLANTA pulse.

PulseUserBasedBookingFavorites

Information

  • Supports GET/POST/DELETE

  • Enables interaction with the posting favorite flag.

PulseWorkloadSubscription

Information

  • Supports POST

  • It is opened by a PLANTA pulse subscription to create loads.

Subordinate

Information

  • Supports GET

  • Returns the child resource structure of the parent resource.

TestImplementation

Information

  • Supports GET/POST/PUT/DELETE

  • Dummy class with non-implemented GET/POST/PUT/DELETE methods

UserBasedAttendance

Information

  • Supports GET

  • Returns the periods as well as possible subordinate presence times of the respective user.

VersionImplementation

Information

  • Supports GET

  • Returns the license and the customizing version of the system.

Workload

Information

  • Supports GET

  • Returns the loads of the respective user.

Details

  • The results can further be restricted via optional parameters:

    • startDate (Date)

    • endDate (Date)

    • modifiedSince (Date)

    • modifiedUntil (Date)

WorkloadInterface

Information

  • Supports POST/PUT/DELETE

  • Enables interaction with load records.

ModuleReaderImplementation

Information

  • Supports GET

  • This endpoint can be used to read out a module released in PLANTA project via the web.

    • The query parameters are passed on to the module class. The data for a module are provided as JSON by default. If you pass on “format=json-schema”, you get a JSON schema file for the module instead of the module data.

  • An API token is used for authentication at the endpoint (note: no API token is supplied for this endpoint in the standard system; it must be created by the customer.

  • The implementation checks whether the requested module is released for the web. If so, it is opened via a macro module (009DVH) in a PLSYSTEM session and the read_module_data_for_web() method is called.

Transformer

ConvertBoardIdToTaskAttribute

Information

  • Expects the ID of a record from the external system which is linked to PLANTA project.

  • Returns the value of the specified data item.

Parameter

  • task_python_id

    • Python ID of the data item which is to be read by the task.

  • external_system_identifier

    • Code of the external system (729 for Jira or 728 for PLANTA pulse).

DateTransformer

Information

  • In the case of GET, the PLANTA date will be returned as a string in the specified format.

  • In the case of POST/PUT, a date as a string in the specified format which will be converted to the internal PLANTA format is expected.

  • Can only be used on date fields.

Parameter

  • format

    • is set to '%d.%m.%Y’ by default

    • For more detailed descriptions on possible formats can be found here

Decoder

Information

  • Decodes the transmitted value with the specified encoding and returns it.

Parameter

  • encoding

    • Encoding of the transmitted value.

DefaultCostTypeFromPulseUser

Information

  • Expects the ID of a user from PLANTA pulse which is linked with PLANTA project.

  • Returns the default cost type of the resource of the user.

DefaultCostTypeFromResource

Information

  • Expects the ID of a resource from PLANTA project.

  • Returns the default cost type of the resource.

GetResourceViaId

Information

  • Expects the ID of a user from Jira which is linked with PLANTA project.

  • Returns the ID of the resource of the user.

ISO8601Transformer

Information

  • In the case of GET it returns the PLANTA date + time of the respective line in ISO 8601 format.

  • In the case of POST/PUT, a date as a string in ISO 8601 format which will be converted to the internal PLANTA format is expected.

Parameter

  • date

    • Must point to a date field via a relative parameter in order for the day to be calculated correctly under GET.

Notes

  • If the transformer is only used for modification access, the date parameter must not be filled.

  • Only works on time fields.

JiraDefaultCostTypeFromResource

Information

  • Expects the ID of a user from Jira which is linked with PLANTA project.

  • Returns the default cost type of the resource of the user.

ListboxValueToCategoryTransformer

Information

  • The transformer allows you to build end points which work with values that are more clearly readable than PLANTA listbox values.

    • An example for the implementation can be found in the "Pulse: Attendance" entities, where the presence type is communicated as a readable text.

Details

  • The listbox_category parameter must be set to a valid listbox category.

  • The transformer then converts between the values in the LBVAL and Category data items (DT447 Listbox values).

LoadFromTimeSpentSeconds

Information

  • Expects a value in seconds.

  • Returns the value in hours as float.

ProjectFromTask

Information

  • Expects the UUID of a task in PLANTA project.

  • Returns the technical project ID.

PulseDateTransformer

Information

  • In the case of GET, the PLANTA date will be returned as a string in yyyy-MM-dd format.

  • In the case of POST/PUT, a date is expected as a string in yyyy-MM-dd format which will be converted into the internal PLANTA format.

  • Only works on date fields.

PulseUserIdToPLANTAUser

Information

  • In the case of GET, the ID of the PLANTA pulse user which is linked to the specified PLANTA project user will be returned.

  • In the case of POST/PUT, the ID of the PLANTA project user which is linked to the specified PLANTA pulse user will be returned.

Slicer

Information

  • Returns the transmitted value in accordance with the number of characters corresponding to the parameter.

Parameter

  • cutoff

    • is set to 80 by default.

TaskFromUuid

Information

  • Expects the UUID of a task in PLANTA project.

  • Returns the technical task ID.

TextDecoder

see "Decoder"

UserToResource

Information

  • Expects the UUID of a user in PLANTA project.

  • Returns the ID of the resource of the user.

UserToResourceViaEmail

Information

  • Expects the e-mail address of a user in PLANTA project.

  • Returns the ID of the resource of the user.

JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close