Package pro.taskana.common.rest

Class TaskanaEngineController

java.lang.Object
pro.taskana.common.rest.TaskanaEngineController
@RestController @EnableHypermediaSupport(type=HAL) public class TaskanaEngineController extends Object
Controller for TaskanaEngine related tasks.

  • Method Details

    • getDomains

      @GetMapping(path="/api/v1/domains") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<List<String>> getDomains()
      This endpoint retrieves all configured Domains.
      Returns:
      An array with the domain-names as strings

    • getClassificationCategories

      @GetMapping(path="/api/v1/classification-categories") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<List<String>> getClassificationCategories(@RequestParam(required=false) String type)
      This endpoint retrieves the configured classification categories for a specific classification type.
      Parameters:
      type - the classification type whose categories should be determined. If not specified all classification categories will be returned.
      Returns:
      the classification categories for the requested type.

    • getClassificationTypes

      @GetMapping(path="/api/v1/classification-types") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<List<String>> getClassificationTypes()
      This endpoint retrieves the configured classification types.
      Returns:
      the configured classification types.

    • getClassificationCategoriesByTypeMap

      @GetMapping(path="/api/v1/classifications-by-type") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<Map<String,List<String>>> getClassificationCategoriesByTypeMap()
      This endpoint retrieves all configured classification categories grouped by each classification type.
      Returns:
      the configured classification categories

    • getCurrentUserInfo

      @GetMapping(path="/api/v1/current-user-info") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<TaskanaUserInfoRepresentationModel> getCurrentUserInfo()
      This endpoint computes all information of the current user.
      Returns:
      the information of the current user.

    • getIsHistoryProviderEnabled

      @GetMapping(path="/api/v1/history-provider-enabled") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<Boolean> getIsHistoryProviderEnabled()
      This endpoint checks if the history module is in use.
      Returns:
      true, when the history is enabled, otherwise false

    • getCustomAttributes

      @GetMapping(path="/api/v1/config/custom-attributes") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<CustomAttributesRepresentationModel> getCustomAttributes()
      This endpoint retrieves the saved custom configuration.
      Returns:
      custom configuration

    • setCustomAttributes

      @PutMapping(path="/api/v1/config/custom-attributes") @Transactional(rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<CustomAttributesRepresentationModel> setCustomAttributes(@RequestBody CustomAttributesRepresentationModel customAttributes)
      This endpoint overrides the custom configuration.
      Parameters:
      customAttributes - the new custom configuration
      Returns:
      the new custom configuration

    • currentVersion

      @GetMapping(path="/api/v1/version") @Transactional(readOnly=true, rollbackFor=java.lang.Exception.class) public org.springframework.http.ResponseEntity<VersionRepresentationModel> currentVersion()
      Get the current application version.
      Returns:
      The current version.