{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Admin Account Workflow Schemes API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflow Schemes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Bulk Get Workflow Schemes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/read",
            "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 in the workflow scheme is associated with."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* global permission to access all, including project-scoped, workflow schemes<br> *  *Administer projects* project permissions to access project-scoped workflow schemes"
        },
        {
          "info": {
            "name": "Atlassian Update Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an [asynchronous task](#async) migrates the issues as defined in the provided mappings.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* project permission to update all, including global-scoped, workflow schemes.<br> *  *Administer project"
        },
        {
          "info": {
            "name": "Atlassian Get Required Status Mappings For Workflow Scheme Update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/update/mappings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.<br><br>**[Permissions](#permissions) required:**<br><br> *  *Administer Jira* permission to update all, including global-scoped, workflow schemes.<br> *  *Administer projects* project permission to update project-scoped workflow schemes."
        },
        {
          "info": {
            "name": "Atlassian Get Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*."
              },
              {
                "name": "returnDraftIfExists",
                "value": "",
                "type": "query",
                "description": "Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned."
              }
            ]
          },
          "docs": "Returns a workflow scheme.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Classic Update Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a company-manged project 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`.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Delete Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*."
              }
            ]
          },
          "docs": "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).<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Get Default Workflow",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/default",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "returnDraftIfExists",
                "value": "",
                "type": "query",
                "description": "Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned."
              }
            ]
          },
          "docs": "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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Update Default Workflow",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/default",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets the default workflow for a workflow scheme.<br><br>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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Delete Default Workflow",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/default",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "updateDraftIfNeeded",
                "value": "",
                "type": "query",
                "description": "Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`."
              }
            ]
          },
          "docs": "Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).<br><br>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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://conf"
        },
        {
          "info": {
            "name": "Atlassian Get Workflow For Issue Type In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/issuetype/:issueType",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "issueType",
                "value": "",
                "type": "path",
                "description": "The ID of the issue type."
              },
              {
                "name": "returnDraftIfExists",
                "value": "",
                "type": "query",
                "description": "Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned."
              }
            ]
          },
          "docs": "Returns the issue type-workflow mapping for an issue type in a workflow scheme.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Set Workflow For Issue Type In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/issuetype/:issueType",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "issueType",
                "value": "",
                "type": "path",
                "description": "The ID of the issue type."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets the workflow for an issue type in a workflow scheme.<br><br>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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Delete Workflow For Issue Type In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/issuetype/:issueType",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "issueType",
                "value": "",
                "type": "path",
                "description": "The ID of the issue type."
              },
              {
                "name": "updateDraftIfNeeded",
                "value": "",
                "type": "query",
                "description": "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`."
              }
            ]
          },
          "docs": "Deletes the issue type-workflow mapping for an issue type in a workflow scheme.<br><br>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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Get Issue Types For Workflows In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/workflow",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "workflowName",
                "value": "",
                "type": "query",
                "description": "The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow."
              },
              {
                "name": "returnDraftIfExists",
                "value": "",
                "type": "query",
                "description": "Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned."
              }
            ]
          },
          "docs": "Returns the workflow-issue type mappings for a workflow scheme.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Set Issue Types For Workflow In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/workflow",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "workflowName",
                "value": "",
                "type": "query",
                "description": "The name of the workflow."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.<br><br>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.<br><br>**[P"
        },
        {
          "info": {
            "name": "Atlassian Delete Issue Types For Workflow In Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme/:id/workflow",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the workflow scheme."
              },
              {
                "name": "workflowName",
                "value": "",
                "type": "query",
                "description": "The name of the workflow."
              },
              {
                "name": "updateDraftIfNeeded",
                "value": "",
                "type": "query",
                "description": "Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`."
              }
            ]
          },
          "docs": "Deletes the workflow-issue type mapping for a workflow in a workflow scheme.<br><br>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.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Get All Workflow Schemes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme",
            "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."
              }
            ]
          },
          "docs": "Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        },
        {
          "info": {
            "name": "Atlassian Create Workflow Scheme",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.atlassian.com/rest/api/3/workflowscheme",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a workflow scheme.<br><br>**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
        }
      ]
    }
  ],
  "bundled": true
}