GET /rest/api/2/workflowscheme/{id}

Returns a workflow scheme.

Permissions required: Administer Jira global permission.

Servers

Path parameters

Name Type Required Description
id Integer Yes

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.

Query parameters

Name Type Required Description
returnDraftIfExists Boolean No

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.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.