Class StepRestResource

java.lang.Object
jakarta.ws.rs.core.Application
org.tasktide.api.TaskTideRestApi
org.tasktide.api.resources.services.rest.StepRestResource
@RequestScoped @Path("/services/step") public class StepRestResource extends TaskTideRestApi
REST resource for interacting with StepService

  • Constructor Summary

    Constructors
    Constructor
    Description
    StepRestResource()
    Construct with Step TaskTideService

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    createNamedStep(String stepName, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create a new empty Step, returning created resource to the client
    jakarta.ws.rs.core.Response
    createStep(Step step, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to create provided Step, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    createSteps(List<Step> steps, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint to import provided Step collection, returning whether the resource was created to the client
    jakarta.ws.rs.core.Response
    dropStep(String id, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for dropping Step by Id
    jakarta.ws.rs.core.Response
    readStep(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 Step by Id, field having value, or field having value for a group having a value
    jakarta.ws.rs.core.Response
    updateStep(Step step, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)
    Endpoint for updating Step providing new resource

    Methods inherited from class jakarta.ws.rs.core.Application

    getClasses, getProperties, getSingletons

    Methods inherited from class Object

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

  • Constructor Details

  • Method Details

    • createStep

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

    • createSteps

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

    • createNamedStep

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

    • readStep

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

    • dropStep

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

    • updateStep

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