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

Class WorkflowSchemesApi

java.lang.Object

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

public class WorkflowSchemesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WorkflowSchemesApi(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>	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.Completable	deleteWorkflowMapping(Long id, 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.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<PageBeanWorkflowScheme>	getAllWorkflowSchemes(Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get all workflow schemes Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes.
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<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<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>	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>	updateWorkflowMapping(Long id, String workflowName, IssueTypesWorkflowMapping issueTypesWorkflowMapping, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowSchemesApi

public WorkflowSchemesApi(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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

deleteWorkflowMapping

public io.reactivex.Completable deleteWorkflowMapping(Long id,
                                                      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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the workflow scheme. (required)

workflowName - The name of the workflow. (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:

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

getAllWorkflowSchemes

public io.reactivex.Single<PageBeanWorkflowScheme> getAllWorkflowSchemes(Optional<Long> startAt,
                                                                         Optional<Integer> maxResults,
                                                                         Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get all workflow schemes Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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)

restRequestEnhancer -

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

Returns:

Single<PageBeanWorkflowScheme>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>

updateWorkflowMapping

public io.reactivex.Single<WorkflowScheme> updateWorkflowMapping(Long id,
                                                                 String workflowName,
                                                                 IssueTypesWorkflowMapping issueTypesWorkflowMapping,
                                                                 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the workflow scheme. (required)

workflowName - The name of the workflow. (required)

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

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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

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>