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

Class WorkflowRuleConfigApi

java.lang.Object

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

public class WorkflowRuleConfigApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanWorkflowTransitionRules>	getWorkflowTransitionRuleConfigurations(Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> types, Optional<List<String>> keys, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow transition rule configurations Returns a paginated list of workflows with transition rules.
io.reactivex.Single<WorkflowTransitionRulesUpdateErrors>	updateWorkflowTransitionRuleConfigurations(WorkflowTransitionRulesUpdate workflowTransitionRulesUpdate, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update workflow transition rule configurations Updates configuration of workflow transition rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowRuleConfigApi

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

Method Detail

getWorkflowTransitionRuleConfigurations

public io.reactivex.Single<PageBeanWorkflowTransitionRules> getWorkflowTransitionRuleConfigurations(Optional<Long> startAt,
                                                                                                    Optional<Integer> maxResults,
                                                                                                    Optional<List<String>> types,
                                                                                                    Optional<List<String>> keys,
                                                                                                    Optional<String> expand,
                                                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflow transition rule configurations

Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:

• of one or more transition rule types, such as workflow post functions.
• matching one or more transition rule keys.

Only workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect apps can use this operation.

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

types -

The types of the transition rules to return.

(optional, default to new ArrayList<>())

keys -

The transition rule class keys, as defined in the Connect app descriptor, of the transition rules 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:

• transition For each rule, returns information about the transition the rule is assigned to.

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

updateWorkflowTransitionRuleConfigurations

public io.reactivex.Single<WorkflowTransitionRulesUpdateErrors> updateWorkflowTransitionRuleConfigurations(WorkflowTransitionRulesUpdate workflowTransitionRulesUpdate,
                                                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update workflow transition rule configurations

Updates configuration of workflow transition rules. The following rule types are supported:

• post functions
• conditions
• validators

Only rules created by the calling Connect app can be updated.

Permissions required: Only Connect apps can use this operation.

Parameters:

workflowTransitionRulesUpdate - (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<WorkflowTransitionRulesUpdateErrors>