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

Class WorkflowTransitionApi

java.lang.Object

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

public class WorkflowTransitionApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<WorkflowTransitionProperty>	createWorkflowTransitionProperty(Long transitionId, WorkflowTransitionProperty requestBody, Optional<String> key, Optional<String> workflowName, Optional<String> workflowMode, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create workflow transition property Adds a property to a workflow transition.
io.reactivex.Completable	deleteWorkflowTransitionProperty(Long transitionId, Optional<String> key, Optional<String> workflowName, Optional<String> workflowMode, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete workflow transition property Deletes a property from a workflow transition.
io.reactivex.Single<WorkflowTransitionProperty>	getWorkflowTransitionProperties(Long transitionId, Optional<Boolean> includeReservedKeys, Optional<String> key, Optional<String> workflowName, Optional<String> workflowMode, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow transition properties Returns the properties on a workflow transition.
io.reactivex.Single<WorkflowTransitionProperty>	updateWorkflowTransitionProperty(Long transitionId, WorkflowTransitionProperty requestBody, Optional<String> key, Optional<String> workflowName, Optional<String> workflowMode, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update workflow transition property Updates a workflow transition by changing the property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowTransitionApi

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

Method Detail

createWorkflowTransitionProperty

public io.reactivex.Single<WorkflowTransitionProperty> createWorkflowTransitionProperty(Long transitionId,
                                                                                        WorkflowTransitionProperty requestBody,
                                                                                        Optional<String> key,
                                                                                        Optional<String> workflowName,
                                                                                        Optional<String> workflowMode,
                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create workflow transition property

Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters:

transitionId -

The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.

(required)

requestBody - (required)

key -

The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.

(optional)

workflowName -

The name of the workflow that the transition belongs to.

(optional)

workflowMode -

The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

(optional, default to live)

restRequestEnhancer -

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

Returns:

Single<WorkflowTransitionProperty>

deleteWorkflowTransitionProperty

public io.reactivex.Completable deleteWorkflowTransitionProperty(Long transitionId,
                                                                 Optional<String> key,
                                                                 Optional<String> workflowName,
                                                                 Optional<String> workflowMode,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete workflow transition property

Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters:

transitionId -

The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.

(required)

key -

The name of the transition property to delete, also known as the name of the property.

(optional)

workflowName -

The name of the workflow that the transition belongs to.

(optional)

workflowMode -

The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

(optional)

restRequestEnhancer -

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

Returns:

Completable

getWorkflowTransitionProperties

public io.reactivex.Single<WorkflowTransitionProperty> getWorkflowTransitionProperties(Long transitionId,
                                                                                       Optional<Boolean> includeReservedKeys,
                                                                                       Optional<String> key,
                                                                                       Optional<String> workflowName,
                                                                                       Optional<String> workflowMode,
                                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflow transition properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters:

transitionId -

The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.

(required)

includeReservedKeys -

Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.

(optional, default to false)

key -

The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.

(optional)

workflowName -

The name of the workflow that the transition belongs to.

(optional)

workflowMode -

The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.

(optional, default to live)

restRequestEnhancer -

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

Returns:

Single<WorkflowTransitionProperty>

updateWorkflowTransitionProperty

public io.reactivex.Single<WorkflowTransitionProperty> updateWorkflowTransitionProperty(Long transitionId,
                                                                                        WorkflowTransitionProperty requestBody,
                                                                                        Optional<String> key,
                                                                                        Optional<String> workflowName,
                                                                                        Optional<String> workflowMode,
                                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update workflow transition property

Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

Permissions required: Administer Jira global permission.

Parameters:

transitionId -

The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.

(required)

requestBody - (required)

key -

The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body.

(optional)

workflowName -

The name of the workflow that the transition belongs to.

(optional)

workflowMode -

The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

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