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

Class WorkflowSearchApi

java.lang.Object

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

public class WorkflowSearchApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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 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

WorkflowSearchApi

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

Method Detail

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 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 required: Administer Jira global permission.

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 to include additional information in the response. This parameter accepts multiple values separated by a comma:

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