Class WorkItemRestResource

java.lang.Object
org.tasktide.api.resources.services.rest.WorkItemRestResource
@Path("/services/workitem") @RequestScoped public class WorkItemRestResource extends Object
REST resource for interacting with WorkItemService

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorkItemRestResource()
    Construct with WorkItem TaskTideService

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    addTaskToWorkItem(ItemTask itemTask, String itemId, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for adding ItemTask to a WorkItem,
    jakarta.ws.rs.core.Response
    createWorkItem(ManagerTask managerTask, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create a new empty WorkItem, returning created resource to the client
    jakarta.ws.rs.core.Response
    createWorkItem(WorkItem workItem, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create provided WorkItem, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    createWorkItems(List<WorkItem> workItems, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to import provided WorkItem collection, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    dropWorkItem(String id, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for dropping WorkItem by Id
    jakarta.ws.rs.core.Response
    readWorkItem(String id, String field, String value, String grouping, String groupingVal, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for fetching WorkItem by Id, field having value, or field having value for a group having a value
    jakarta.ws.rs.core.Response
    updateWorkItem(WorkItem workItem, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for updating WorkItem providing new resource

    Methods inherited from class Object

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

  • Constructor Details

  • Method Details

    • createWorkItem

      @POST @Path("/add") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkItem(WorkItem workItem, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint to create provided WorkItem, returning whether the resource was created to the client
      Parameters:
      workItem -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • createWorkItems

      @POST @Path("/import") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkItems(List<WorkItem> workItems, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint to import provided WorkItem collection, returning whether the resource was created to the client
      Parameters:
      workItems -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • createWorkItem

      @POST @Path("/create") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkItem(ManagerTask managerTask, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint to create a new empty WorkItem, returning created resource to the client
      Parameters:
      managerTask -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • readWorkItem

      @GET @Path("/get") @Produces("application/json") public jakarta.ws.rs.core.Response readWorkItem(@QueryParam("id") String id, @QueryParam("field") String field, @QueryParam("value") String value, @QueryParam("grouping") String grouping, @QueryParam("groupingValue") String groupingVal, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint for fetching WorkItem by Id, field having value, or field having value for a group having a value
      Parameters:
      id -
      field -
      value -
      grouping -
      groupingVal -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • dropWorkItem

      @DELETE @Path("/drop/{id}") @Produces("application/json") public jakarta.ws.rs.core.Response dropWorkItem(@PathParam("id") String id, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint for dropping WorkItem by Id
      Parameters:
      id -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • updateWorkItem

      @PUT @Path("/update") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response updateWorkItem(WorkItem workItem, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint for updating WorkItem providing new resource
      Parameters:
      workItem -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • addTaskToWorkItem

      @PUT @Path("/add-task") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response addTaskToWorkItem(ItemTask itemTask, @QueryParam("itemId") String itemId, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint for adding ItemTask to a WorkItem,
      Parameters:
      itemTask -
      itemId -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response