Package com.gentics.contentnode.rest.resource

Interface RoleResource

@Path("/role")
public interface RoleResource

Resource for management of roles

Method Summary

Modifier and Type	Method	Description
RoleResponse	create(RoleModel role)	Create new role
jakarta.ws.rs.core.Response	delete(String id)	Delete a role
RoleResponse	get(String id)	Get existing role
RolePermResponse	getPerm(String id)	Get role permissions
RoleListResponse	list(FilterParameterBean filter, SortParameterBean sorting, PagingParameterBean paging, PermsParameterBean perms)	Get list of roles. The result can be filtered by id name description and sorted by id name description
RoleResponse	update(String id, RoleModel role)	Update a role
RolePermResponse	updatePerm(String id, RolePermissionsModel updatedPerms)	Update role permissions

Method Details

list

@GET
RoleListResponse list(@BeanParam
 FilterParameterBean filter,
 @BeanParam
 SortParameterBean sorting,
 @BeanParam
 PagingParameterBean paging,
 @BeanParam
 PermsParameterBean perms)
               throws Exception

Get list of roles.
The result can be filtered by

• id
• name
• description

and sorted by

• id
• name
• description

Parameters:

filter - filter parameters

sorting - sorting parameters

paging - paging parameters

perms - permissions parameters

Returns:

list response

Throws:

Exception

create

@PUT
RoleResponse create(RoleModel role)
             throws Exception

Create new role

Parameters:

role - role

Returns:

response containing created role

Throws:

Exception

get

@GET
@Path("/{id}")
RoleResponse get(@PathParam("id")
 String id)
          throws Exception

Get existing role

Parameters:

id - role ID

Returns:

response containing the role

Throws:

Exception

update

@POST
@Path("/{id}")
RoleResponse update(@PathParam("id")
 String id,
 RoleModel role)
             throws Exception

Update a role

Parameters:

id - role ID

role - updated role data

Returns:

response containing the updated role

Throws:

Exception

delete

@DELETE
@Path("/{id}")
jakarta.ws.rs.core.Response delete(@PathParam("id")
 String id)
                            throws Exception

Delete a role

Parameters:

id - role ID

Returns:

empty response

Throws:

Exception

getPerm

@GET
@Path("/{id}/perm")
RolePermResponse getPerm(@PathParam("id")
 String id)
                  throws Exception

Get role permissions

Parameters:

id - role ID

Returns:

role permissions

Throws:

Exception

updatePerm

@POST
@Path("/{id}/perm")
RolePermResponse updatePerm(@PathParam("id")
 String id,
 RolePermissionsModel updatedPerms)
                     throws Exception

Update role permissions

Parameters:

id - role ID

updatedPerms - permissions

Returns:

updated permissions

Throws:

Exception