Workflow schemes

Get issue types for workflows in workflow scheme

Returns the workflow-issue type mappings for a workflow scheme.

Permissions required: Administer Jira global permission.

get/rest/api/2/workflowscheme/{id}/workflow

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/workflowscheme/{id}/workflow
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Path parameters

idinteger required

The ID of the workflow scheme.

Query parameters

workflowNamestring

The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.

returnDraftIfExistsboolean

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.

Response

Returned if the request is successful.

defaultMappingboolean

Whether the workflow is the default workflow for the workflow scheme.

issueTypesstring[]

The list of issue type IDs.

updateDraftIfNeededboolean

Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.

workflowstring

The name of the workflow. Optional if updating the workflow-issue types mapping.

Changes

No recorded changes to this operation across all 26 revisions of this API.