pro.taskana.rest

Class WorkbasketDefinitionController

java.lang.Object

pro.taskana.rest.WorkbasketDefinitionController

@RestController
 @RequestMapping(path="/v1/workbasket-definitions",
                produces="application/json")
public class WorkbasketDefinitionController
extends 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<List<pro.taskana.WorkbasketSummary>>	exportWorkbaskets(String domain)
org.springframework.http.ResponseEntity<String>	importWorkbaskets(org.springframework.web.multipart.MultipartFile file) 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<List<pro.taskana.WorkbasketSummary>> exportWorkbaskets(@RequestParam(required=false)
                                                                                                                                                                                                       String domain)

importWorkbaskets

@PostMapping
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<String> importWorkbaskets(@RequestParam(value="file")
                                                                                                                                             org.springframework.web.multipart.MultipartFile file)
                                                                                                                                      throws IOException,
                                                                                                                                             pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                             pro.taskana.exceptions.DomainNotFoundException,
                                                                                                                                             pro.taskana.exceptions.InvalidWorkbasketException,
                                                                                                                                             pro.taskana.exceptions.WorkbasketAlreadyExistException,
                                                                                                                                             pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                             pro.taskana.exceptions.InvalidArgumentException

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:

file - 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

Throws:

IOException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.DomainNotFoundException

pro.taskana.exceptions.InvalidWorkbasketException

pro.taskana.exceptions.WorkbasketAlreadyExistException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.InvalidArgumentException