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

Class WorkflowSchemeDraftsApi

java.lang.Object

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

public class WorkflowSchemeDraftsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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>	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, 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	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<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<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<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>	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, 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's draft.
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

WorkflowSchemeDraftsApi

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

Method Detail

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

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>

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

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

Parameters:

id - The ID of the workflow scheme that the draft belongs to. (required)

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

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

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

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>

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

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

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>

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

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

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>

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

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>

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

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

Parameters:

id - The ID of the workflow scheme that the draft belongs to. (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>

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

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>