Package com.xebialabs.xlrelease.api.v1
Interface EnvironmentLabelApi
- All Superinterfaces:
ApiService
@Path("/api/v1/environments/labels")
@Consumes("application/json")
@Produces("application/json")
public interface EnvironmentLabelApi
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
(EnvironmentLabel environmentLabel) Creates a new environment label.createLabel
(EnvironmentLabelForm labelForm) void
Deletes an environment label.Gets an environment label by id.getLabelById
(String environmentLabelId) search
(EnvironmentLabelFilters filters) Searches environment labels by filters.searchLabels
(EnvironmentLabelFilters filters) default String
update
(EnvironmentLabel environmentLabel) Updates an existing environment label.updateLabel
(String environmentLabelId, EnvironmentLabelForm labelForm)
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
createLabel
-
getLabelById
@GET @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") EnvironmentLabelView getLabelById(@PathParam("environmentLabelId") String environmentLabelId) -
updateLabel
@PUT @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") EnvironmentLabelView updateLabel(@PathParam("environmentLabelId") String environmentLabelId, EnvironmentLabelForm labelForm) -
searchLabels
-
delete
@DELETE @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") void delete(@PathParam("environmentLabelId") String environmentLabelId) Deletes an environment label.- Parameters:
environmentLabelId
- the environment label identifier
-
create
Creates a new environment label.- Parameters:
environmentLabel
- anEnvironmentLabel
object describing the new environment label- Returns:
- created
EnvironmentLabel
object
-
getById
Gets an environment label by id.- Parameters:
id
- the environment label identifier- Returns:
- found
EnvironmentLabel
object
-
update
Updates an existing environment label.- Parameters:
environmentLabel
- anEnvironmentLabel
object describing the new properties of the environment label- Returns:
- updated
EnvironmentLabel
object
-
search
Searches environment labels by filters.- Parameters:
filters
- anEnvironmentTypeFilters
object describing the search criteria- Returns:
- list of matching
EnvironmentLabel
s
-