Interface EnvironmentStageApi

All Superinterfaces:
ApiService

@Path("/api/v1/environments/stages") @Consumes("application/json") @Produces("application/json") public interface EnvironmentStageApi extends ApiService
  • Method Details

    • serviceName

      default String serviceName()
      Specified by:
      serviceName in interface ApiService
    • createStage

      @POST EnvironmentStageView createStage(EnvironmentStageForm stageForm)
    • getStageById

      @GET @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") EnvironmentStageView getStageById(@PathParam("environmentStageId") String environmentStageId)
    • updateStage

      @PUT @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") EnvironmentStageView updateStage(@PathParam("environmentStageId") String environmentStageId, EnvironmentStageForm stageForm)
    • searchStages

      @POST @Path("/search") List<EnvironmentStageView> searchStages(EnvironmentStageFilters filters)
    • delete

      @DELETE @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") void delete(@PathParam("environmentStageId") String environmentStageId)
      Deletes an environment stage.
      Parameters:
      environmentStageId - the environment stage identifier
    • create

      EnvironmentStage create(EnvironmentStage environmentStage)
      Creates a new environment stage.
      Parameters:
      environmentStage - an EnvironmentStage object describing the new environment category
      Returns:
      created EnvironmentStage object
    • getById

      EnvironmentStage getById(String environmentStageId)
      Gets an environment category by id.
      Parameters:
      environmentStageId - the environment stage identifier
      Returns:
      found EnvironmentStage object
    • update

      EnvironmentStage update(EnvironmentStage environmentCategory)
      Updates an existing environment stage.
      Parameters:
      environmentCategory - an EnvironmentStage object describing the new properties of the environment category
      Returns:
      updated EnvironmentStage object
    • search

      Searches environment stages by filters.
      Parameters:
      filters - an EnvironmentStageFilters object describing the search criteria
      Returns:
      list of matching EnvironmentStages