Package com.xebialabs.xlrelease.api.v1

Interface EnvironmentStageApi

All Superinterfaces:
ApiService
@Path("/api/v1/environments/stages") @Consumes("application/json") @Produces("application/json") public interface EnvironmentStageApi extends ApiService

  • Field Summary

    Fields inherited from interface com.xebialabs.xlrelease.api.ApiService

    DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA

  • Method Summary

    Modifier and Type
    Method
    Description
    com.xebialabs.xlrelease.domain.environments.EnvironmentStage
    create(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentStage)
    Creates a new environment stage.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView
    createStage(com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)
     
    void
    delete(String environmentStageId)
    Deletes an environment stage.
    com.xebialabs.xlrelease.domain.environments.EnvironmentStage
    getById(String environmentStageId)
    Gets an environment category by id.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView
    getStageById(String environmentStageId)
     
    List<com.xebialabs.xlrelease.domain.environments.EnvironmentStage>
    search(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)
    Searches environment stages by filters.
    List<com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView>
    searchStages(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)
     
    default String
    serviceName()
     
    com.xebialabs.xlrelease.domain.environments.EnvironmentStage
    update(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentCategory)
    Updates an existing environment stage.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView
    updateStage(String environmentStageId, com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)
     

  • Method Details

    • serviceName

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

    • createStage

      @POST com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView createStage(com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)

    • getStageById

      @GET @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView getStageById(@PathParam("environmentStageId") String environmentStageId)

    • updateStage

      @PUT @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView updateStage(@PathParam("environmentStageId") String environmentStageId, com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)

    • searchStages

      @POST @Path("/search") List<com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView> searchStages(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)

    • delete

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

    • create

      com.xebialabs.xlrelease.domain.environments.EnvironmentStage create(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentStage)
      Creates a new environment stage.
      Parameters:
      environmentStage - an EnvironmentStage object describing the new environment category
      Returns:
      created EnvironmentStage object

    • getById

      com.xebialabs.xlrelease.domain.environments.EnvironmentStage getById(String environmentStageId)
      Gets an environment category by id.
      Parameters:
      environmentStageId - the environment stage identifier
      Returns:
      found EnvironmentStage object

    • update

      com.xebialabs.xlrelease.domain.environments.EnvironmentStage update(com.xebialabs.xlrelease.domain.environments.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

      List<com.xebialabs.xlrelease.domain.environments.EnvironmentStage> search(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)
      Searches environment stages by filters.
      Parameters:
      filters - an EnvironmentStageFilters object describing the search criteria
      Returns:
      list of matching EnvironmentStages