WorkflowsApi class
Jira Cloud platform REST API documentation
Constructors
- WorkflowsApi(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
-
createWorkflow(
{required CreateWorkflowDetails body}) → Future< WorkflowIDs> - Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.
-
createWorkflows(
{required WorkflowCreateRequest body}) → Future< WorkflowCreateResponse> - Create workflows and related statuses.
-
deleteInactiveWorkflow(
String entityId) → Future< void> - Deletes a workflow.
-
getAllWorkflows(
{String? workflowName}) → Future< List< DeprecatedWorkflow> > - Returns all workflows in Jira or a workflow. Deprecated, use Get workflows paginated.
-
getWorkflowsPaginated(
{int? startAt, int? maxResults, List< String> ? workflowName, String? expand, String? queryString, String? orderBy, bool? isActive}) → Future<PageBeanWorkflow> - Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readWorkflows(
{String? expand, required WorkflowReadRequest body}) → Future< WorkflowReadResponse> - Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateWorkflows(
{String? expand, required WorkflowUpdateRequest body}) → Future< WorkflowUpdateResponse> - Update workflows and related statuses.
-
validateCreateWorkflows(
{required WorkflowCreateValidateRequest body}) → Future< WorkflowValidationErrorList> - Validate the payload for bulk create workflows.
-
validateUpdateWorkflows(
{required WorkflowUpdateValidateRequestBean body}) → Future< WorkflowValidationErrorList> - Validate the payload for bulk update workflows.
-
workflowCapabilities(
{String? workflowId, String? projectId, String? issueTypeId}) → Future< WorkflowCapabilities> - Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited