Package pro.taskana.workbasket.rest

Class WorkbasketAccessItemController

java.lang.Object

pro.taskana.workbasket.rest.WorkbasketAccessItemController

@RestController
@EnableHypermediaSupport(type=HAL)
public class WorkbasketAccessItemController
extends Object

Controller for Workbasket access.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkbasketAccessItemController.WorkbasketAccessItemQuerySortParameter
static enum	WorkbasketAccessItemController.WorkbasketAccessItemSortBy

Constructor Summary

Constructors

Constructor	Description
WorkbasketAccessItemController(LdapClient ldapClient, pro.taskana.workbasket.api.WorkbasketService workbasketService, WorkbasketAccessItemRepresentationModelAssembler modelAssembler)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<WorkbasketAccessItemPagedRepresentationModel>	getWorkbasketAccessItems(jakarta.servlet.http.HttpServletRequest request, WorkbasketAccessItemQueryFilterParameter filterParameter, WorkbasketAccessItemController.WorkbasketAccessItemQuerySortParameter sortParameter, QueryPagingParameter<pro.taskana.workbasket.api.models.WorkbasketAccessItem,pro.taskana.workbasket.api.WorkbasketAccessItemQuery> pagingParameter)	This endpoint retrieves a list of existing Workbasket Access Items.
org.springframework.http.ResponseEntity<Void>	removeWorkbasketAccessItems(String accessId)	This endpoint deletes all Workbasket Access Items for a provided Access Id.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkbasketAccessItemController

@Autowired
public WorkbasketAccessItemController(LdapClient ldapClient,
 pro.taskana.workbasket.api.WorkbasketService workbasketService,
 WorkbasketAccessItemRepresentationModelAssembler modelAssembler)

Method Details

getWorkbasketAccessItems

@GetMapping(path="/api/v1/workbasket-access-items")
public org.springframework.http.ResponseEntity<WorkbasketAccessItemPagedRepresentationModel> getWorkbasketAccessItems(jakarta.servlet.http.HttpServletRequest request,
 WorkbasketAccessItemQueryFilterParameter filterParameter,
 WorkbasketAccessItemController.WorkbasketAccessItemQuerySortParameter sortParameter,
 QueryPagingParameter<pro.taskana.workbasket.api.models.WorkbasketAccessItem,pro.taskana.workbasket.api.WorkbasketAccessItemQuery> pagingParameter)
                                                                                                               throws pro.taskana.common.api.exceptions.NotAuthorizedException

This endpoint retrieves a list of existing Workbasket Access Items. Filters can be applied.

Parameters:

request - the HTTP request

filterParameter - the filter parameters

sortParameter - the sort parameters

pagingParameter - the paging parameters

Returns:

the Workbasket Access Items with the given filter, sort and paging options.

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException - if the user is not authorized.

removeWorkbasketAccessItems

@DeleteMapping(path="/api/v1/workbasket-access-items")
public org.springframework.http.ResponseEntity<Void> removeWorkbasketAccessItems(@RequestParam("access-id")
 String accessId)
                                                                          throws pro.taskana.common.api.exceptions.NotAuthorizedException,
pro.taskana.common.api.exceptions.InvalidArgumentException

This endpoint deletes all Workbasket Access Items for a provided Access Id.

Parameters:

accessId - the Access Id whose Workbasket Access Items should be removed

Returns:

no content

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException - if the user is not authorized.

pro.taskana.common.api.exceptions.InvalidArgumentException - if some argument is invalid.