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

Class StatusApi

java.lang.Object

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

public class StatusApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<JiraStatus>>	createStatuses(StatusCreateRequest statusCreateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk create statuses Creates statuses for a global or project scope.
io.reactivex.Single<Object>	deleteStatusesById(Optional<List<String>> id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk delete Statuses Deletes statuses by ID.
io.reactivex.Single<List<JiraStatus>>	getStatusesById(Optional<String> expand, Optional<List<String>> id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk get statuses Returns a list of the statuses specified by one or more status IDs.
io.reactivex.Single<PageOfStatuses>	search(Optional<String> expand, Optional<String> projectId, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> searchString, Optional<String> statusCategory, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Search statuses paginated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of statuses that match a search on name or project.
io.reactivex.Single<Object>	updateStatuses(StatusUpdateRequest statusUpdateRequest, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Bulk update statuses Updates statuses by ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusApi

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

Method Detail

createStatuses

public io.reactivex.Single<List<JiraStatus>> createStatuses(StatusCreateRequest statusCreateRequest,
                                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk create statuses Creates statuses for a global or project scope. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

Parameters:

statusCreateRequest - Details of the statuses being created and their scope. (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<List<JiraStatus>>

deleteStatusesById

public io.reactivex.Single<Object> deleteStatusesById(Optional<List<String>> id,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk delete Statuses Deletes statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

Parameters:

id - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items `1`, Max items `50` (optional, default to new ArrayList<>())

restRequestEnhancer -

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

Returns:

Single<Object>

getStatusesById

public io.reactivex.Single<List<JiraStatus>> getStatusesById(Optional<String> expand,
                                                             Optional<List<String>> id,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk get statuses Returns a list of the statuses specified by one or more status IDs. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

Parameters:

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `usages` Returns the project and issue types that use the status in their workflow. * `workflowUsages` Returns the workflows that use the status. (optional)

id - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Min items `1`, Max items `50` (optional, default to new ArrayList<>())

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

search

public io.reactivex.Single<PageOfStatuses> search(Optional<String> expand,
                                                  Optional<String> projectId,
                                                  Optional<Long> startAt,
                                                  Optional<Integer> maxResults,
                                                  Optional<String> searchString,
                                                  Optional<String> statusCategory,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Search statuses paginated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of statuses that match a search on name or project. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

Parameters:

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `usages` Returns the project and issue types that use the status in their workflow. * `workflowUsages` Returns the workflows that use the status. (optional)

projectId - The project the status is part of or null for global statuses. (optional)

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 200)

searchString - Term to match status names against or null to search for all statuses in the search scope. (optional)

statusCategory - Category of the status to filter by. The supported values are: `TODO`, `IN_PROGRESS`, and `DONE`. (optional)

restRequestEnhancer -

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

Returns:

Single<PageOfStatuses>

updateStatuses

public io.reactivex.Single<Object> updateStatuses(StatusUpdateRequest statusUpdateRequest,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Bulk update statuses Updates statuses by ID. **[Permissions](#permissions) required:** * *Administer projects* [project permission.](https://confluence.atlassian.com/x/yodKLg) * *Administer Jira* [project permission.](https://confluence.atlassian.com/x/yodKLg)

Parameters:

statusUpdateRequest - The list of statuses that will be updated. (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<Object>