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

Class WorkflowsApi

java.lang.Object

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

public class WorkflowsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<DeprecatedWorkflow>>	getAllWorkflows(Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Deprecated.
io.reactivex.Single<PageBeanWorkflow>	getWorkflowsPaginated(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> workflowName, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflows paginated Returns a [paginated](#pagination) list of published classic workflows.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowsApi

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

Method Detail

getAllWorkflows

@Deprecated
public io.reactivex.Single<List<DeprecatedWorkflow>> getAllWorkflows(Optional<String> workflowName,
                                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Deprecated.

Get all workflows Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-2-workflow-search-get). If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

workflowName - The name of the workflow to be returned. Only one workflow can be specified. (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<List<DeprecatedWorkflow>>

getWorkflowsPaginated

public io.reactivex.Single<PageBeanWorkflow> getWorkflowsPaginated(Optional<Long> startAt,
                                                                   Optional<Integer> maxResults,
                                                                   Optional<List<String>> workflowName,
                                                                   Optional<String> expand,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflows paginated Returns a [paginated](#pagination) list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned. This operation does not return next-gen workflows. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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 50)

workflowName - The name of a workflow to return. (optional, default to new ArrayList<>())

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `transitions` For each workflow, returns information about the transitions inside the workflow. * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested. * `statuses` For each workflow, returns information about the statuses inside the workflow. * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. (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<PageBeanWorkflow>