Module workflow_schemes_api

Enums

CreateWorkflowSchemeError

struct for typed errors of method create_workflow_scheme

DeleteDefaultWorkflowError

struct for typed errors of method delete_default_workflow

DeleteWorkflowMappingError

struct for typed errors of method delete_workflow_mapping

DeleteWorkflowSchemeError

struct for typed errors of method delete_workflow_scheme

DeleteWorkflowSchemeIssueTypeError

struct for typed errors of method delete_workflow_scheme_issue_type

GetAllWorkflowSchemesError

struct for typed errors of method get_all_workflow_schemes

GetDefaultWorkflowError

struct for typed errors of method get_default_workflow

GetWorkflowError

struct for typed errors of method get_workflow

GetWorkflowSchemeError

struct for typed errors of method get_workflow_scheme

GetWorkflowSchemeIssueTypeError

struct for typed errors of method get_workflow_scheme_issue_type

SetWorkflowSchemeIssueTypeError

struct for typed errors of method set_workflow_scheme_issue_type

UpdateDefaultWorkflowError

struct for typed errors of method update_default_workflow

UpdateWorkflowMappingError

struct for typed errors of method update_workflow_mapping

UpdateWorkflowSchemeError

struct for typed errors of method update_workflow_scheme

Functions

create_workflow_scheme

Creates a workflow scheme. Permissions required: Administer Jira global permission.

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.

delete_workflow_mapping

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.

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.

delete_workflow_scheme_issue_type

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.

get_all_workflow_schemes

Returns a paginated list of all workflow schemes, not including draft workflow schemes. Permissions required: Administer Jira global permission.

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.

get_workflow

Returns the workflow-issue type mappings for a workflow scheme. Permissions required: Administer Jira global permission.

get_workflow_scheme

Returns a workflow scheme. Permissions required: Administer Jira global permission.

get_workflow_scheme_issue_type

Returns the issue type-workflow mapping for an issue type in a workflow scheme. Permissions required: Administer Jira global permission.

set_workflow_scheme_issue_type

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.

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.

update_workflow_mapping

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.

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.