org.everit.atlassian.restclient.jiracloud.v2.api

Class ProjectRolesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.ProjectRolesApi

public class ProjectRolesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectRolesApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ProjectRole>	createProjectRole(CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create project role Creates a new project role with no [default actors](#api-rest-api-2-resolution-get).
io.reactivex.Completable	deleteProjectRole(Long id, Optional<Long> swap, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project role Deletes a project role.
io.reactivex.Single<ProjectRole>	fullyUpdateProjectRole(Long id, CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Fully update project role Updates the project role's name and description.
io.reactivex.Single<List<ProjectRole>>	getAllProjectRoles(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all project roles Gets a list of all project roles, complete with project role details and default actors. ### About project roles ### [Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with projects.
io.reactivex.Single<ProjectRole>	getProjectRole(String projectIdOrKey, Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project role for project Returns a project role's details and actors associated with the project.
io.reactivex.Single<ProjectRole>	getProjectRoleById(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project role by ID Gets the project role details and the default actors associated with the role.
io.reactivex.Single<List<ProjectRole>>	getProjectRoleDetails(String projectIdOrKey, Optional<Boolean> currentMember, Optional<Boolean> excludeConnectAddons, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project role details Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role.
io.reactivex.Single<Map<String,URI>>	getProjectRoles(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project roles for project Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and self URL for each role.
io.reactivex.Single<ProjectRole>	partialUpdateProjectRole(Long id, CreateUpdateRoleRequestBean createUpdateRoleRequestBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Partial update project role Updates either the project role's name or its description.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRolesApi

public ProjectRolesApi(org.everit.http.restclient.RestClient restClient)

Method Detail

createProjectRole

public io.reactivex.Single<ProjectRole> createProjectRole(CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create project role Creates a new project role with no [default actors](#api-rest-api-2-resolution-get). You can use the [Add default actors to project role](#api-rest-api-2-role-id-actors-post) operation to add default actors to the project role after creating it. *Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.*< **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

createUpdateRoleRequestBean - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectRole>

deleteProjectRole

public io.reactivex.Completable deleteProjectRole(Long id,
                                                  Optional<Long> swap,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete project role Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role to delete. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

swap - The ID of the project role that will replace the one being deleted. (optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

fullyUpdateProjectRole

public io.reactivex.Single<ProjectRole> fullyUpdateProjectRole(Long id,
                                                               CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Fully update project role Updates the project role's name and description. You must include both a name and a description in the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

createUpdateRoleRequestBean - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectRole>

getAllProjectRoles

public io.reactivex.Single<List<ProjectRole>> getAllProjectRoles(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all project roles Gets a list of all project roles, complete with project role details and default actors. ### About project roles ### [Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications). Project roles are used in [permission schemes](#api-rest-api-2-permissionscheme-get), [email notification schemes](#api-rest-api-2-notificationscheme-get), [issue security levels](#api-rest-api-2-issuesecurityschemes-get), [comment visibility](#api-rest-api-2-comment-list-post), and workflow conditions. #### Members and actors #### In the Jira REST API, a member of a project role is called an *actor*. An *actor* is a group or user associated with a project role. Actors may be set as [default members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) of the project role or set at the project level: * Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired. * Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<ProjectRole>>

getProjectRole

public io.reactivex.Single<ProjectRole> getProjectRole(String projectIdOrKey,
                                                       Long id,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project role for project Returns a project role's details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-2-user-get) with the `groups` expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectRole>

getProjectRoleById

public io.reactivex.Single<ProjectRole> getProjectRoleById(Long id,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project role by ID Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectRole>

getProjectRoleDetails

public io.reactivex.Single<List<ProjectRole>> getProjectRoleDetails(String projectIdOrKey,
                                                                    Optional<Boolean> currentMember,
                                                                    Optional<Boolean> excludeConnectAddons,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project role details Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the list of project roles is common to all projects. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

currentMember - Whether the roles should be filtered to include only those the user is assigned to. (optional, default to false)

excludeConnectAddons - (optional, default to false)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<ProjectRole>>

getProjectRoles

public io.reactivex.Single<Map<String,URI>> getProjectRoles(String projectIdOrKey,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project roles for project Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and self URL for each role. Note that all project roles are shared with all projects in Jira Cloud. See [Get all project roles](#api-rest-api-2-role-get) for more information. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for any project on the site or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Map<String, URI>>

partialUpdateProjectRole

public io.reactivex.Single<ProjectRole> partialUpdateProjectRole(Long id,
                                                                 CreateUpdateRoleRequestBean createUpdateRoleRequestBean,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Partial update project role Updates either the project role's name or its description. You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

createUpdateRoleRequestBean - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ProjectRole>