Interface EnvironmentStageApi

  • All Superinterfaces:
    ApiService

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

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService
      • getStageById

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

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

        @DELETE
        @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}")
        void delete​(@PathParam("environmentStageId")
                    java.lang.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​(java.lang.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

        java.util.List<EnvironmentStage> search​(EnvironmentStageFilters filters)
        Searches environment stages by filters.
        Parameters:
        filters - an EnvironmentStageFilters object describing the search criteria
        Returns:
        list of matching EnvironmentStages