Package com.xebialabs.xlrelease.api.v1
Interface RolesApi
- All Superinterfaces:
ApiService
@Path("/api/v1/roles")
@Consumes("application/json")
@Produces("application/json")
public interface RolesApi
extends ApiService
Operations related to roles.
-
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 TypeMethodDescriptionvoid
void
void
Returns the paginated list of roles ordered by role name.void
default String
void
void
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
getRoles
@GET List<RoleView> getRoles(@DefaultValue("0") @QueryParam("page") Integer page, @DefaultValue("100") @QueryParam("resultsPerPage") Integer resultsPerPage) Returns the paginated list of roles ordered by role name.- Parameters:
page
- the page of results to return. Default value is 0.resultsPerPage
- the number of results per page. Default value is 100. Maximum value is 100.- Returns:
- a list of roles.
-
getRole
-
create
-
create
-
update
-
update
-
delete
-
rename
-