{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Workflows API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Workflows Paginated", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/workflow/search", "params": [ { "name": "startAt", "value": "", "type": "query", "description": "The index of the first item to return in a page of results (page offset)." }, { "name": "maxResults", "value": "", "type": "query", "description": "The maximum number of items to return per page." }, { "name": "workflowName", "value": "", "type": "query", "description": "The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, `workflowName=name1&workflowName=name2`." }, { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `transitions` For each workflow, returns information about the transitions inside the workflow.\n * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.\n * `transitions.properties` For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested.\n * `statuses` For each workflow, returns information about the statuses inside the workflow.\n * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.\n * `default` For each workflow, returns information about whether this is the default workflow.\n * `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to.\n * `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes.\n * `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version.\n * `operations` For each workflow, returns information about the actions that can be undertaken on the workflow." }, { "name": "queryString", "value": "", "type": "query", "description": "String used to perform a case-insensitive partial match with workflow name." }, { "name": "orderBy", "value": "", "type": "query", "description": "[Order](#ordering) the results by a field:\n\n * `name` Sorts by workflow name.\n * `created` Sorts by create time.\n * `updated` Sorts by update time." }, { "name": "isActive", "value": "", "type": "query", "description": "Filters active and inactive workflows." } ] }, "docs": "Returns a [paginated](#pagination) list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Delete Inactive Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/workflow/:entityId", "params": [ { "name": "entityId", "value": "", "type": "path", "description": "The entity ID of the workflow." } ] }, "docs": "Deletes a workflow.

The workflow cannot be deleted if it is:

* an active workflow.
* a system workflow.
* associated with any workflow scheme.
* associated with any draft workflow scheme.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Get Available Workflow Capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/workflows/capabilities", "params": [ { "name": "workflowId", "value": "", "type": "query" }, { "name": "projectId", "value": "", "type": "query" }, { "name": "issueTypeId", "value": "", "type": "query" } ] }, "docs": "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).

**[Permissions](#permissions) req" }, { "info": { "name": "Atlassian Bulk Create Workflows", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflows/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create workflows and related statuses.

**[Permissions](#permissions) required:**

* *Administer Jira* project permission to create all, including global-scoped, workflows
* *Administer projects* project permissions to create project-scoped workflows" }, { "info": { "name": "Atlassian Validate Create Workflows", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflows/create/validation", "body": { "type": "json", "data": "{}" } }, "docs": "Validate the payload for bulk create workflows.

**[Permissions](#permissions) required:**

* *Administer Jira* project permission to create all, including global-scoped, workflows
* *Administer projects* project permissions to create project-scoped workflows" }, { "info": { "name": "Atlassian Bulk Update Workflows", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflows/update", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `workflows.usages` Returns the project and issue types that each workflow is associated with.\n * `statuses.usages` Returns the project and issue types that each status is associated with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update workflows and related statuses.

**[Permissions](#permissions) required:**

* *Administer Jira* project permission to create all, including global-scoped, workflows
* *Administer projects* project permissions to create project-scoped workflows" }, { "info": { "name": "Atlassian Validate Update Workflows", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflows/update/validation", "body": { "type": "json", "data": "{}" } }, "docs": "Validate the payload for bulk update workflows.

**[Permissions](#permissions) required:**

* *Administer Jira* project permission to create all, including global-scoped, workflows
* *Administer projects* project permissions to create project-scoped workflows" }, { "info": { "name": "Atlassian Get All Workflows", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/workflow", "params": [ { "name": "workflowName", "value": "", "type": "query", "description": "The name of the workflow to be returned. Only one workflow can be specified." } ] }, "docs": "Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-3-workflow-search-get).

If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Create Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflow", "body": { "type": "json", "data": "{}" } }, "docs": "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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post) to create both team and company-managed scoped workflows.

#### Conditions ####

Condition" }, { "info": { "name": "Atlassian Bulk Get Workflows", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflows", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `workflows.usages` Returns the project and issue types that each workflow is associated with.\n * `statuses.usages` Returns the project and issue types that each status is associated with." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

**[Permissions](#permissions) required:**

* *Administer Jira* global permission to access all, including project-scoped, workflows
* At least one of the *Administer projects* and *View (read-only) workflow* project permissions to access project-scoped workflows" } ] } ], "bundled": true }