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 TypeMethodDescriptioncreate
(EnvironmentStage environmentStage) Creates a new environment stage.createStage
(EnvironmentStageForm stageForm) void
Deletes an environment stage.Gets an environment category by id.getStageById
(String environmentStageId) search
(EnvironmentStageFilters filters) Searches environment stages by filters.searchStages
(EnvironmentStageFilters filters) default String
update
(EnvironmentStage environmentCategory) Updates an existing environment stage.updateStage
(String environmentStageId, EnvironmentStageForm stageForm)
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
createStage
-
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
-
delete
@DELETE @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") void delete(@PathParam("environmentStageId") String environmentStageId) Deletes an environment stage.- Parameters:
environmentStageId
- the environment stage identifier
-
create
Creates a new environment stage.- Parameters:
environmentStage
- anEnvironmentStage
object describing the new environment category- Returns:
- created
EnvironmentStage
object
-
getById
Gets an environment category by id.- Parameters:
environmentStageId
- the environment stage identifier- Returns:
- found
EnvironmentStage
object
-
update
Updates an existing environment stage.- Parameters:
environmentCategory
- anEnvironmentStage
object describing the new properties of the environment category- Returns:
- updated
EnvironmentStage
object
-
search
Searches environment stages by filters.- Parameters:
filters
- anEnvironmentStageFilters
object describing the search criteria- Returns:
- list of matching
EnvironmentStage
s
-