WorkflowSchemesApi class
Jira Cloud platform REST API documentation
Constructors
- WorkflowSchemesApi(ApiClient _client)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createWorkflowScheme(
{required WorkflowScheme body}) → Future< WorkflowScheme> - Creates a workflow scheme.
-
deleteDefaultWorkflow(
{required int id, bool? updateDraftIfNeeded}) → Future< WorkflowScheme> - Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).
-
deleteWorkflowMapping(
{required int id, required String workflowName, bool? updateDraftIfNeeded}) → Future< void> - Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
-
deleteWorkflowScheme(
int id) → Future - 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).
-
deleteWorkflowSchemeIssueType(
{required int id, required String issueType, bool? updateDraftIfNeeded}) → Future< WorkflowScheme> - Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
-
getAllWorkflowSchemes(
{int? startAt, int? maxResults}) → Future< PageBeanWorkflowScheme> - Returns a paginated list of all workflow schemes, not including draft workflow schemes.
-
getDefaultWorkflow(
{required int id, bool? returnDraftIfExists}) → Future< DefaultWorkflow> - 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.
-
getWorkflow(
{required int id, String? workflowName, bool? returnDraftIfExists}) → Future< IssueTypesWorkflowMapping> - Returns the workflow-issue type mappings for a workflow scheme.
-
getWorkflowScheme(
{required int id, bool? returnDraftIfExists}) → Future< WorkflowScheme> - Returns a workflow scheme.
-
getWorkflowSchemeIssueType(
{required int id, required String issueType, bool? returnDraftIfExists}) → Future< IssueTypeWorkflowMapping> - Returns the issue type-workflow mapping for an issue type in a workflow scheme.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setWorkflowSchemeIssueType(
{required int id, required String issueType, required IssueTypeWorkflowMapping body}) → Future< WorkflowScheme> - Sets the workflow for an issue type in a workflow scheme.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateDefaultWorkflow(
{required int id, required DefaultWorkflow body}) → Future< WorkflowScheme> - Sets the default workflow for a workflow scheme.
-
updateWorkflowMapping(
{required int id, required String workflowName, required IssueTypesWorkflowMapping body}) → Future< WorkflowScheme> - 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.
-
updateWorkflowScheme(
{required int id, required WorkflowScheme body}) → Future< WorkflowScheme> -
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
updateDraftIfNeededis set totrue.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited