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.

  • Method Details

    • serviceName

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

    • getRoles

      @GET List<com.xebialabs.xlrelease.api.v1.views.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

      @GET @Path("/{roleName:.*[^/]*}") com.xebialabs.xlrelease.api.v1.views.RoleView getRole(@PathParam("roleName") String roleName)

    • create

      @POST @Path("/{roleName:.*[^/]*}") void create(@PathParam("roleName") String roleName, com.xebialabs.xlrelease.api.v1.views.RoleView roleView)

    • create

      @POST void create(List<com.xebialabs.xlrelease.api.v1.views.RoleView> roleViews)

    • update

      @PUT @Path("/{roleName:.*[^/]*}") void update(@PathParam("roleName") String roleName, com.xebialabs.xlrelease.api.v1.views.RoleView roleView)

    • update

      @PUT void update(List<com.xebialabs.xlrelease.api.v1.views.RoleView> roleViews)

    • delete

      @DELETE @Path("/{roleName:.*[^/]*}") void delete(@PathParam("roleName") String roleName)

    • rename

      @POST @Path("/{roleName:.*[^/]*}/rename") void rename(@PathParam("roleName") String roleName, @QueryParam("newName") String newName)