Class WorkflowRestResource

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    WorkflowRestResource()
    Construct with Workflow TaskTideService

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    addStep(String workflowId, String stepId, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for adding Step to a Workflow, returning updated Workflow
    jakarta.ws.rs.core.Response
    createWorkflow(String workflowName, String stepId, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create a new empty Workflow, returning created resource to the client
    jakarta.ws.rs.core.Response
    createWorkflow(Workflow workflow, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create provided Workflow, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    createWorkflows(List<Workflow> workflows, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to import provided Workflow collection, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    dropWorkflow(String id, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for dropping Workflow by Id
    jakarta.ws.rs.core.Response
    readWorkflow(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 Workflow by Id, field having value, or field having value for a group having a value
    jakarta.ws.rs.core.Response
    updateWorkflow(Workflow workflow, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for updating Workflow providing new resource

    Methods inherited from class Object

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

  • Constructor Details

  • Method Details

    • createWorkflow

      @POST @Path("/add") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkflow(Workflow workflow, @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 Workflow, returning whether the resource was created to the client
      Parameters:
      workflow -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • createWorkflows

      @POST @Path("/import") @Consumes("application/json") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkflows(List<Workflow> workflows, @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 Workflow collection, returning whether the resource was created to the client
      Parameters:
      workflows -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • createWorkflow

      @POST @Path("/create") @Produces("application/json") public jakarta.ws.rs.core.Response createWorkflow(@QueryParam("workflowName") String workflowName, @QueryParam("stepId") String stepId, @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 Workflow, returning created resource to the client
      Parameters:
      workflowName -
      stepId -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • readWorkflow

      @GET @Path("/get") @Produces("application/json") public jakarta.ws.rs.core.Response readWorkflow(@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 Workflow 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

    • addStep

      @PUT @Path("/add-step") @Produces("application/json") public jakarta.ws.rs.core.Response addStep(@QueryParam("workflowId") String workflowId, @QueryParam("stepId") String stepId, @Context jakarta.ws.rs.core.HttpHeaders reqHeader, @Context jakarta.ws.rs.core.UriInfo uriInfo, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Endpoint for adding Step to a Workflow, returning updated Workflow
      Parameters:
      workflowId -
      stepId -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • dropWorkflow

      @DELETE @Path("/drop/{id}") @Produces("application/json") public jakarta.ws.rs.core.Response dropWorkflow(@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 Workflow by Id
      Parameters:
      id -
      reqHeader -
      uriInfo -
      securityContext -
      Returns:
      Response

    • updateWorkflow

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