pro.taskana.rest

Class WorkbasketController

java.lang.Object

pro.taskana.rest.WorkbasketController

@RestController
 @RequestMapping(path="/v1/workbaskets",
                produces="application/json")
public class WorkbasketController
extends Object

Controller for all Workbasket related endpoints.

Constructor Summary

Constructors

Constructor and Description
WorkbasketController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<WorkbasketResource>	createWorkbasket(WorkbasketResource workbasketResource)
org.springframework.http.ResponseEntity<WorkbasketAccessItemResource>	createWorkbasketAccessItem(WorkbasketAccessItemResource workbasketAccessItemResource)
org.springframework.http.ResponseEntity<?>	deleteWorkbasket(String workbasketId)
org.springframework.http.ResponseEntity<?>	deleteWorkbasketAccessItem(String authId)
org.springframework.http.ResponseEntity<List<WorkbasketSummaryResource>>	getDistributionTargetsForWorkbasketId(String workbasketId)
org.springframework.http.ResponseEntity<WorkbasketResource>	getWorkbasket(String workbasketId)
org.springframework.http.ResponseEntity<List<WorkbasketAccessItemResource>>	getWorkbasketAccessItems(String workbasketId)
org.springframework.http.ResponseEntity<List<WorkbasketSummaryResource>>	getWorkbaskets(String sortBy, String order, String name, String nameLike, String key, String keyLike, String descLike, String owner, String ownerLike, String type, String requiredPermission)
org.springframework.http.ResponseEntity<?>	setDistributionTargetsForWorkbasketId(String sourceWorkbasketId, List<String> targetWorkbasketIds)
org.springframework.http.ResponseEntity<?>	setWorkbasketAccessItems(String workbasketId, List<WorkbasketAccessItemResource> workbasketAccessResourceItems)
org.springframework.http.ResponseEntity<WorkbasketResource>	updateWorkbasket(String workbasketId, WorkbasketResource workbasketResource)
org.springframework.http.ResponseEntity<WorkbasketAccessItemResource>	updateWorkbasketAccessItem(String authId, WorkbasketAccessItemResource workbasketAccessItemResource)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkbasketController

public WorkbasketController()

Method Detail

getWorkbaskets

@GetMapping
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<List<WorkbasketSummaryResource>> getWorkbaskets(@RequestParam(value="sortBy",defaultValue="name",required=false)
                                                                                                                                                                                                String sortBy,
                                                                                                                                                                                                @RequestParam(value="order",defaultValue="asc",required=false)
                                                                                                                                                                                                String order,
                                                                                                                                                                                                @RequestParam(value="name",required=false)
                                                                                                                                                                                                String name,
                                                                                                                                                                                                @RequestParam(value="nameLike",required=false)
                                                                                                                                                                                                String nameLike,
                                                                                                                                                                                                @RequestParam(value="key",required=false)
                                                                                                                                                                                                String key,
                                                                                                                                                                                                @RequestParam(value="keyLike",required=false)
                                                                                                                                                                                                String keyLike,
                                                                                                                                                                                                @RequestParam(value="descLike",required=false)
                                                                                                                                                                                                String descLike,
                                                                                                                                                                                                @RequestParam(value="owner",required=false)
                                                                                                                                                                                                String owner,
                                                                                                                                                                                                @RequestParam(value="ownerLike",required=false)
                                                                                                                                                                                                String ownerLike,
                                                                                                                                                                                                @RequestParam(value="type",required=false)
                                                                                                                                                                                                String type,
                                                                                                                                                                                                @RequestParam(value="requiredPermission",required=false)
                                                                                                                                                                                                String requiredPermission)

getWorkbasket

@GetMapping(path="/{workbasketId}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> getWorkbasket(@PathVariable(value="workbasketId")
                                                                                                                                                                                                          String workbasketId)

deleteWorkbasket

@DeleteMapping(path="/{workbasketId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<?> deleteWorkbasket(@PathVariable(value="workbasketId")
                                                                                                                                                                 String workbasketId)

createWorkbasket

@PostMapping
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> createWorkbasket(@RequestBody
                                                                                                                                                        WorkbasketResource workbasketResource)
                                                                                                                                                 throws pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.NotAuthorizedException

updateWorkbasket

@PutMapping(path="/{workbasketId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> updateWorkbasket(@PathVariable(value="workbasketId")
                                                                                                                                                                               String workbasketId,
                                                                                                                                                                               @RequestBody
                                                                                                                                                                               WorkbasketResource workbasketResource)

getWorkbasketAccessItems

@GetMapping(path="/{workbasketId}/workbasketAccessItems")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<List<WorkbasketAccessItemResource>> getWorkbasketAccessItems(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                           String workbasketId)

createWorkbasketAccessItem

@PostMapping(path="/workbasketAccessItems")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketAccessItemResource> createWorkbasketAccessItem(@RequestBody
                                                                                                                                                                                                           WorkbasketAccessItemResource workbasketAccessItemResource)
                                                                                                                                                                                                    throws pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.NotAuthorizedException

updateWorkbasketAccessItem

@PutMapping(path="/workbasketAccessItems/{workbasketAccessItemId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketAccessItemResource> updateWorkbasketAccessItem(@PathVariable(value="authId")
                                                                                                                                                                                                                                   String authId,
                                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                                   WorkbasketAccessItemResource workbasketAccessItemResource)

setWorkbasketAccessItems

@PutMapping(value="/{workbasketId}/workbasketAccessItems/")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<?> setWorkbasketAccessItems(@PathVariable(value="workbasketId")
                                                                                                                                                                                              String workbasketId,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              List<WorkbasketAccessItemResource> workbasketAccessResourceItems)

deleteWorkbasketAccessItem

@DeleteMapping(path="/workbasketAccessItems/{workbasketAccessItemId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<?> deleteWorkbasketAccessItem(@PathVariable(value="authId")
                                                                                                                                                                                                           String authId)
                                                                                                                                                                                                    throws pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.NotAuthorizedException

getDistributionTargetsForWorkbasketId

@GetMapping(path="/{workbasketId}/distributiontargets")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<List<WorkbasketSummaryResource>> getDistributionTargetsForWorkbasketId(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                   String workbasketId)

setDistributionTargetsForWorkbasketId

@PutMapping(path="/{workbasketId}/distributiontargets")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<?> setDistributionTargetsForWorkbasketId(@PathVariable(value="workbasketId")
                                                                                                                                                                                                       String sourceWorkbasketId,
                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                       List<String> targetWorkbasketIds)