Package com.atlassian.jira.rest.v2.issue.project

Class RoleResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.project.RoleResource

@Path("role")
@Consumes("application/json")
@Produces("application/json")
public class RoleResource
extends Object

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
RoleResource(ProjectRoleService projectRoleService, ProjectRoleBeanFactory projectRoleBeanFactory, ResponseFactory responses, I18nHelper i18n, JiraAuthenticationContext authContext, GlobalPermissionManager permissionManager)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addProjectRoleActorsToRole(long roleId, ActorInputBean actorsInput)	Adds default actors to the given role.
javax.ws.rs.core.Response	createProjectRole(CreateUpdateRoleRequestBean inputBean)	Creates a new ProjectRole to be available in Jira.
javax.ws.rs.core.Response	deleteProjectRole(long roleId, Long roleIdToSwap)	Deletes a role.
javax.ws.rs.core.Response	deleteProjectRoleActorsFromRole(long roleId, String user, String group)	Removes default actor from the given role.
javax.ws.rs.core.Response	fullyUpdateProjectRole(long roleId, CreateUpdateRoleRequestBean updateProjectRoleBean)	Fully updates a roles.
javax.ws.rs.core.Response	getProjectRoleActorsForRole(long roleId)	Gets default actors for the given role.
javax.ws.rs.core.Response	getProjectRoles()	Get all the ProjectRoles available in Jira.
javax.ws.rs.core.Response	getProjectRolesById(long roleId)	Get a specific ProjectRole available in Jira.
javax.ws.rs.core.Response	partialUpdateProjectRole(long roleId, CreateUpdateRoleRequestBean updateProjectRoleBean)	Partially updates a roles name or description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RoleResource

@Inject
public RoleResource(ProjectRoleService projectRoleService,
 ProjectRoleBeanFactory projectRoleBeanFactory,
 ResponseFactory responses,
 I18nHelper i18n,
 JiraAuthenticationContext authContext,
 GlobalPermissionManager permissionManager)

Method Details

getProjectRoles

@GET
public javax.ws.rs.core.Response getProjectRoles()

Get all the ProjectRoles available in Jira. Currently this list is global.

Returns:

Returns full details of the roles available in Jira.

getProjectRolesById

@GET
@Path("{id}")
public javax.ws.rs.core.Response getProjectRolesById(@PathParam("id")
 long roleId)

Get a specific ProjectRole available in Jira.

Returns:

Returns full details of the role available in Jira.

createProjectRole

@POST
public javax.ws.rs.core.Response createProjectRole(CreateUpdateRoleRequestBean inputBean)

Creates a new ProjectRole to be available in Jira. The created role does not have any default actors assigned.

Returns:

Returns full details of the created role

partialUpdateProjectRole

@POST
@Path("{id}")
public javax.ws.rs.core.Response partialUpdateProjectRole(@PathParam("id")
 long roleId,
 CreateUpdateRoleRequestBean updateProjectRoleBean)

Partially updates a roles name or description.

Returns:

Returns updated role.

fullyUpdateProjectRole

@PUT
@Path("{id}")
public javax.ws.rs.core.Response fullyUpdateProjectRole(@PathParam("id")
 long roleId,
 CreateUpdateRoleRequestBean updateProjectRoleBean)

Fully updates a roles. Both name and description must be given.

Returns:

Returns updated role.

deleteProjectRole

@DELETE
@Path("{id}")
public javax.ws.rs.core.Response deleteProjectRole(@PathParam("id")
 long roleId,
 @QueryParam("swap")
 Long roleIdToSwap)

Deletes a role. May return 403 in the future

Parameters:

roleIdToSwap - if given, removes a role even if it is used in scheme by replacing the role with the given one

getProjectRoleActorsForRole

@GET
@Path("{id}/actors")
public javax.ws.rs.core.Response getProjectRoleActorsForRole(@PathParam("id")
 long roleId)

Gets default actors for the given role.

Returns:

Returns actor list.

addProjectRoleActorsToRole

@POST
@Path("{id}/actors")
public javax.ws.rs.core.Response addProjectRoleActorsToRole(@PathParam("id")
 long roleId,
 ActorInputBean actorsInput)

Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.

Returns:

Returns actor list.

deleteProjectRoleActorsFromRole

@DELETE
@Path("{id}/actors")
public javax.ws.rs.core.Response deleteProjectRoleActorsFromRole(@PathParam("id")
 long roleId,
 @QueryParam("user")
 String user,
 @QueryParam("group")
 String group)

Removes default actor from the given role.

Parameters:

roleId - the role id to remove the actors from

user - if given, removes an actor from given role

group - if given, removes an actor from given role

Returns:

Returns updated actors list.