org.everit.atlassian.restclient.jiracloud.v3.api

Class ProjectCategoryApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.ProjectCategoryApi

public class ProjectCategoryApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ProjectCategory>	createProjectCategory(ProjectCategory projectCategory, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create project category Creates a project category.
io.reactivex.Single<List<ProjectCategory>>	getAllProjectCategories(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all project categories Returns all project categories.
io.reactivex.Single<ProjectCategory>	getProjectCategoryById(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project category by id Returns a project category.
io.reactivex.Completable	removeProjectCategory(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project category Deletes a project category.
io.reactivex.Single<UpdatedProjectCategory>	updateProjectCategory(Long id, ProjectCategory projectCategory, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update project category Updates a project category.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectCategoryApi

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

Method Detail

createProjectCategory

public io.reactivex.Single<ProjectCategory> createProjectCategory(ProjectCategory projectCategory,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create project category

Creates a project category.

Permissions required: Administer Jira global permission.

Parameters:

projectCategory - (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<ProjectCategory>

getAllProjectCategories

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

Get all project categories

Returns all project categories.

Permissions required: Permission to access Jira.

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<ProjectCategory>>

getProjectCategoryById

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

Get project category by id

Returns a project category.

Permissions required: Permission to access Jira.

Parameters:

id -

The ID of the project category.

(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<ProjectCategory>

removeProjectCategory

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

Delete project category

Deletes a project category.

Permissions required: Administer Jira global permission.

Parameters:

id -

ID of the project category to delete.

(required)

restRequestEnhancer -

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

Returns:

Completable

updateProjectCategory

public io.reactivex.Single<UpdatedProjectCategory> updateProjectCategory(Long id,
                                                                         ProjectCategory projectCategory,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update project category

Updates a project category.

Permissions required: Administer Jira global permission.

Parameters:

id - (required)

projectCategory - (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<UpdatedProjectCategory>