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

Class WorkflowSchemeApi

java.lang.Object

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

public class WorkflowSchemeApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<WorkflowScheme>	createWorkflowScheme(WorkflowScheme workflowScheme, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create workflow scheme Creates a workflow scheme.
io.reactivex.Single<WorkflowScheme>	createWorkflowSchemeDraftFromParent(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create draft workflow scheme Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme.
io.reactivex.Single<WorkflowScheme>	deleteDefaultWorkflow(Long id, Optional<Boolean> updateDraftIfNeeded, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete default workflow Resets the default workflow for a workflow scheme.
io.reactivex.Single<WorkflowScheme>	deleteDraftDefaultWorkflow(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete draft default workflow Resets the default workflow for a workflow scheme's draft.
io.reactivex.Completable	deleteDraftWorkflowMapping(Long id, Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue types for workflow in draft workflow scheme Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
io.reactivex.Completable	deleteWorkflowMapping(Long id, Optional<String> workflowName, Optional<Boolean> updateDraftIfNeeded, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete issue types for workflow in workflow scheme Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
io.reactivex.Completable	deleteWorkflowScheme(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete workflow scheme Deletes a workflow scheme.
io.reactivex.Completable	deleteWorkflowSchemeDraft(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete draft workflow scheme Deletes a draft workflow scheme.
io.reactivex.Single<WorkflowScheme>	deleteWorkflowSchemeDraftIssueType(Long id, String issueType, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete workflow for issue type in draft workflow scheme Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
io.reactivex.Single<WorkflowScheme>	deleteWorkflowSchemeIssueType(Long id, String issueType, Optional<Boolean> updateDraftIfNeeded, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete workflow for issue type in workflow scheme Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
io.reactivex.Single<DefaultWorkflow>	getDefaultWorkflow(Long id, Optional<Boolean> returnDraftIfExists, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get default workflow Returns the default workflow for a workflow scheme.
io.reactivex.Single<DefaultWorkflow>	getDraftDefaultWorkflow(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get draft default workflow Returns the default workflow for a workflow scheme's draft.
io.reactivex.Single<IssueTypesWorkflowMapping>	getDraftWorkflow(Long id, Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue types for workflows in draft workflow scheme Returns the workflow-issue type mappings for a workflow scheme's draft.
io.reactivex.Single<IssueTypesWorkflowMapping>	getWorkflow(Long id, Optional<String> workflowName, Optional<Boolean> returnDraftIfExists, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get issue types for workflows in workflow scheme Returns the workflow-issue type mappings for a workflow scheme.
io.reactivex.Single<WorkflowScheme>	getWorkflowScheme(Long id, Optional<Boolean> returnDraftIfExists, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow scheme Returns a workflow scheme.
io.reactivex.Single<WorkflowScheme>	getWorkflowSchemeDraft(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get draft workflow scheme Returns the draft workflow scheme for an active workflow scheme.
io.reactivex.Single<IssueTypeWorkflowMapping>	getWorkflowSchemeDraftIssueType(Long id, String issueType, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow for issue type in draft workflow scheme Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.
io.reactivex.Single<IssueTypeWorkflowMapping>	getWorkflowSchemeIssueType(Long id, String issueType, Optional<Boolean> returnDraftIfExists, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get workflow for issue type in workflow scheme Returns the issue type-workflow mapping for an issue type in a workflow scheme.
io.reactivex.Single<WorkflowScheme>	setWorkflowSchemeDraftIssueType(Long id, String issueType, IssueTypeWorkflowMapping issueTypeWorkflowMapping, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set workflow for issue type in draft workflow scheme Sets the workflow for an issue type in a workflow scheme's draft.
io.reactivex.Single<WorkflowScheme>	setWorkflowSchemeIssueType(Long id, String issueType, IssueTypeWorkflowMapping issueTypeWorkflowMapping, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set workflow for issue type in workflow scheme Sets the workflow for an issue type in a workflow scheme.
io.reactivex.Single<WorkflowScheme>	updateDefaultWorkflow(Long id, DefaultWorkflow defaultWorkflow, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update default workflow Sets the default workflow for a workflow scheme.
io.reactivex.Single<WorkflowScheme>	updateDraftDefaultWorkflow(Long id, DefaultWorkflow defaultWorkflow, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update draft default workflow Sets the default workflow for a workflow scheme's draft.
io.reactivex.Single<WorkflowScheme>	updateDraftWorkflowMapping(Long id, IssueTypesWorkflowMapping issueTypesWorkflowMapping, Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set issue types for workflow in workflow scheme Sets the issue types for a workflow in a workflow scheme's draft.
io.reactivex.Single<WorkflowScheme>	updateWorkflowMapping(Long id, IssueTypesWorkflowMapping issueTypesWorkflowMapping, Optional<String> workflowName, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set issue types for workflow in workflow scheme Sets the issue types for a workflow in a workflow scheme.
io.reactivex.Single<WorkflowScheme>	updateWorkflowScheme(Long id, WorkflowScheme workflowScheme, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update workflow scheme Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more.
io.reactivex.Single<WorkflowScheme>	updateWorkflowSchemeDraft(Long id, WorkflowScheme workflowScheme, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update draft workflow scheme Updates a draft workflow scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowSchemeApi

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

Method Detail

createWorkflowScheme

public io.reactivex.Single<WorkflowScheme> createWorkflowScheme(WorkflowScheme workflowScheme,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create workflow scheme

Creates a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

workflowScheme - (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<WorkflowScheme>

createWorkflowSchemeDraftFromParent

public io.reactivex.Single<WorkflowScheme> createWorkflowSchemeDraftFromParent(Long id,
                                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create draft workflow scheme

Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the active workflow scheme that the draft is created from.

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

deleteDefaultWorkflow

public io.reactivex.Single<WorkflowScheme> deleteDefaultWorkflow(Long id,
                                                                 Optional<Boolean> updateDraftIfNeeded,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete default workflow

Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

updateDraftIfNeeded -

Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.

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

deleteDraftDefaultWorkflow

public io.reactivex.Single<WorkflowScheme> deleteDraftDefaultWorkflow(Long id,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete draft default workflow

Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

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

deleteDraftWorkflowMapping

public io.reactivex.Completable deleteDraftWorkflowMapping(Long id,
                                                           Optional<String> workflowName,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue types for workflow in draft workflow scheme

Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

workflowName -

The name of the workflow.

(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

deleteWorkflowMapping

public io.reactivex.Completable deleteWorkflowMapping(Long id,
                                                      Optional<String> workflowName,
                                                      Optional<Boolean> updateDraftIfNeeded,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete issue types for workflow in workflow scheme

Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

workflowName -

The name of the workflow.

(optional)

updateDraftIfNeeded -

Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.

(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

deleteWorkflowScheme

public io.reactivex.Completable deleteWorkflowScheme(Long id,
                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete workflow scheme

Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

(required)

restRequestEnhancer -

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

Returns:

Completable

deleteWorkflowSchemeDraft

public io.reactivex.Completable deleteWorkflowSchemeDraft(Long id,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete draft workflow scheme

Deletes a draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the active workflow scheme that the draft was created from.

(required)

restRequestEnhancer -

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

Returns:

Completable

deleteWorkflowSchemeDraftIssueType

public io.reactivex.Single<WorkflowScheme> deleteWorkflowSchemeDraftIssueType(Long id,
                                                                              String issueType,
                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete workflow for issue type in draft workflow scheme

Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

issueType -

The ID of the issue type.

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

deleteWorkflowSchemeIssueType

public io.reactivex.Single<WorkflowScheme> deleteWorkflowSchemeIssueType(Long id,
                                                                         String issueType,
                                                                         Optional<Boolean> updateDraftIfNeeded,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete workflow for issue type in workflow scheme

Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

issueType -

The ID of the issue type.

(required)

updateDraftIfNeeded -

Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false.

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

getDefaultWorkflow

public io.reactivex.Single<DefaultWorkflow> getDefaultWorkflow(Long id,
                                                               Optional<Boolean> returnDraftIfExists,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get default workflow

Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

returnDraftIfExists -

Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<DefaultWorkflow>

getDraftDefaultWorkflow

public io.reactivex.Single<DefaultWorkflow> getDraftDefaultWorkflow(Long id,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get draft default workflow

Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

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

getDraftWorkflow

public io.reactivex.Single<IssueTypesWorkflowMapping> getDraftWorkflow(Long id,
                                                                       Optional<String> workflowName,
                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue types for workflows in draft workflow scheme

Returns the workflow-issue type mappings for a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

workflowName -

The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.

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

getWorkflow

public io.reactivex.Single<IssueTypesWorkflowMapping> getWorkflow(Long id,
                                                                  Optional<String> workflowName,
                                                                  Optional<Boolean> returnDraftIfExists,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get issue types for workflows in workflow scheme

Returns the workflow-issue type mappings for a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

workflowName -

The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.

(optional)

returnDraftIfExists -

Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<IssueTypesWorkflowMapping>

getWorkflowScheme

public io.reactivex.Single<WorkflowScheme> getWorkflowScheme(Long id,
                                                             Optional<Boolean> returnDraftIfExists,
                                                             Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflow scheme

Returns a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

(required)

returnDraftIfExists -

Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<WorkflowScheme>

getWorkflowSchemeDraft

public io.reactivex.Single<WorkflowScheme> getWorkflowSchemeDraft(Long id,
                                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get draft workflow scheme

Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note that:

• Only active workflow schemes can have draft workflow schemes.
• An active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the active workflow scheme that the draft was created from.

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

getWorkflowSchemeDraftIssueType

public io.reactivex.Single<IssueTypeWorkflowMapping> getWorkflowSchemeDraftIssueType(Long id,
                                                                                     String issueType,
                                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflow for issue type in draft workflow scheme

Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

issueType -

The ID of the issue type.

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

getWorkflowSchemeIssueType

public io.reactivex.Single<IssueTypeWorkflowMapping> getWorkflowSchemeIssueType(Long id,
                                                                                String issueType,
                                                                                Optional<Boolean> returnDraftIfExists,
                                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get workflow for issue type in workflow scheme

Returns the issue type-workflow mapping for an issue type in a workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

issueType -

The ID of the issue type.

(required)

returnDraftIfExists -

Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.

(optional, default to false)

restRequestEnhancer -

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

Returns:

Single<IssueTypeWorkflowMapping>

setWorkflowSchemeDraftIssueType

public io.reactivex.Single<WorkflowScheme> setWorkflowSchemeDraftIssueType(Long id,
                                                                           String issueType,
                                                                           IssueTypeWorkflowMapping issueTypeWorkflowMapping,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set workflow for issue type in draft workflow scheme

Sets the workflow for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

issueType -

The ID of the issue type.

(required)

issueTypeWorkflowMapping -

The issue type-project mapping.

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

setWorkflowSchemeIssueType

public io.reactivex.Single<WorkflowScheme> setWorkflowSchemeIssueType(Long id,
                                                                      String issueType,
                                                                      IssueTypeWorkflowMapping issueTypeWorkflowMapping,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set workflow for issue type in workflow scheme

Sets the workflow for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

issueType -

The ID of the issue type.

(required)

issueTypeWorkflowMapping -

The issue type-project mapping.

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

updateDefaultWorkflow

public io.reactivex.Single<WorkflowScheme> updateDefaultWorkflow(Long id,
                                                                 DefaultWorkflow defaultWorkflow,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update default workflow

Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

defaultWorkflow -

The new default workflow.

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

updateDraftDefaultWorkflow

public io.reactivex.Single<WorkflowScheme> updateDraftDefaultWorkflow(Long id,
                                                                      DefaultWorkflow defaultWorkflow,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update draft default workflow

Sets the default workflow for a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

defaultWorkflow -

The object for the new default workflow.

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

updateDraftWorkflowMapping

public io.reactivex.Single<WorkflowScheme> updateDraftWorkflowMapping(Long id,
                                                                      IssueTypesWorkflowMapping issueTypesWorkflowMapping,
                                                                      Optional<String> workflowName,
                                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set issue types for workflow in workflow scheme

Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme that the draft belongs to.

(required)

issueTypesWorkflowMapping - (required)

workflowName -

The name of the workflow.

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

updateWorkflowMapping

public io.reactivex.Single<WorkflowScheme> updateWorkflowMapping(Long id,
                                                                 IssueTypesWorkflowMapping issueTypesWorkflowMapping,
                                                                 Optional<String> workflowName,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set issue types for workflow in workflow scheme

Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme.

(required)

issueTypesWorkflowMapping - (required)

workflowName -

The name of the workflow.

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

updateWorkflowScheme

public io.reactivex.Single<WorkflowScheme> updateWorkflowScheme(Long id,
                                                                WorkflowScheme workflowScheme,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update workflow scheme

Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

(required)

workflowScheme - (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<WorkflowScheme>

updateWorkflowSchemeDraft

public io.reactivex.Single<WorkflowScheme> updateWorkflowSchemeDraft(Long id,
                                                                     WorkflowScheme workflowScheme,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update draft workflow scheme

Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters:

id -

The ID of the active workflow scheme that the draft was created from.

(required)

workflowScheme - (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<WorkflowScheme>