pro.taskana.rest

Class WorkbasketDefinitionController

java.lang.Object

pro.taskana.rest.WorkbasketDefinitionController

@RestController
 @RequestMapping(path="/v1/workbasketdefinitions",
                produces="application/json")
public class WorkbasketDefinitionController
extends java.lang.Object

Controller for all WorkbasketDefinition related endpoints.

Constructor Summary

Constructors

Constructor and Description
WorkbasketDefinitionController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<java.util.List<WorkbasketDefinition>>	exportWorkbaskets(java.lang.String domain)
org.springframework.http.ResponseEntity<java.lang.String>	importWorkbaskets(java.util.List<WorkbasketDefinition> definitions) This method imports a list of WorkbasketDefinition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkbasketDefinitionController

public WorkbasketDefinitionController()

Method Detail

exportWorkbaskets

@GetMapping
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.util.List<WorkbasketDefinition>> exportWorkbaskets(@RequestParam(required=false)
                                                                                                                                                                                                        java.lang.String domain)

importWorkbaskets

@PostMapping(path="/import")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.lang.String> importWorkbaskets(@RequestBody
                                                                                                                                                                       java.util.List<WorkbasketDefinition> definitions)

This method imports a list of WorkbasketDefinition. This does not exactly match the REST norm, but we want to have an option to import all settings at once. When a logical equal (key and domain are equal) workbasket already exists an update will be executed. Otherwise a new workbasket will be created.

Parameters:

definitions - the list of workbasket definitions which will be imported to the current system.

Returns:

Return answer is determined by the status code: 200 - all good 400 - list state error (referring to non existing id's) 401 - not authorized