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

Class WorkflowTransitionRulesApi

java.lang.Object

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

public class WorkflowTransitionRulesApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<WorkflowTransitionRulesUpdateErrors>	deleteWorkflowTransitionRuleConfigurations(WorkflowsWithTransitionRulesDetails workflowsWithTransitionRulesDetails, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete workflow transition rule configurations Deletes workflow transition rules from one or more workflows.
io.reactivex.Single<PageBeanWorkflowTransitionRules>	getWorkflowTransitionRuleConfigurations(List<String> types, Optional<Long> startAt, Optional<Integer> maxResults, Optional<List<String>> keys, Optional<List<String>> workflowNames, Optional<List<String>> withTags, Optional<Boolean> draft, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow transition rule configurations Returns a [paginated](#pagination) 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

WorkflowTransitionRulesApi

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

Method Detail

deleteWorkflowTransitionRuleConfigurations

public io.reactivex.Single<WorkflowTransitionRulesUpdateErrors> deleteWorkflowTransitionRuleConfigurations(WorkflowsWithTransitionRulesDetails workflowsWithTransitionRulesDetails,
                                                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete workflow transition rule configurations Deletes workflow transition rules from one or more workflows. These rule types are supported: * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) Only rules created by the calling Connect app can be deleted. **[Permissions](#permissions) required:** Only Connect apps can use this operation.

Parameters:

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

getWorkflowTransitionRuleConfigurations

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

Get workflow transition rule configurations Returns a [paginated](#pagination) 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](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/). * matching one or more transition rule keys. Only workflows containing transition rules created by the calling [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app are returned. Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored. **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation.

Parameters:

types - The types of the transition rules to return. (required)

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)

keys - The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return. (optional, default to new ArrayList<>())

workflowNames - The list of workflow names to filter by. (optional, default to new ArrayList<>())

withTags - The list of `tags` to filter by. (optional, default to new ArrayList<>())

draft - Whether draft or published workflows are returned. If not provided, both workflow types are returned. (optional)

expand - Use [expand](#expansion) to include additional information in the response. This parameter accepts `transition`, which, 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](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) Only rules created by the calling [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app can be updated. To assist with app migration, this operation can be used to: * Disable a rule. * Add a `tag`. Use this to filter rules in the [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Rules are enabled if the `disabled` parameter is not provided. **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) 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>