Get issue types for workflows in workflow scheme

GET

/rest/api/3/workflowscheme/{id}/workflow

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

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/workflowscheme//workflow'

Response Example

200 - Success

{"workflow":"jira","issueTypes":["10000","10001"],"defaultMapping":false}

Request

Path Params

integer

required

The ID of the workflow scheme.

Query Params

workflowName

string

optional

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

returnDraftIfExists

string

optional

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.

Responses

🟢200Returned if the request is successful.

application/json

Body

Details about the mapping between issue types and a workflow.

defaultMapping

boolean

optional

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

issueTypes

array[string]

optional

The list of issue type IDs.

updateDraftIfNeeded

boolean

optional

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.

workflow

string

optional

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

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.

🟠404Returned if either the workflow scheme or workflow is not found.

Modified at 2023-07-13 03:27:27

Delete workflow for issue type in workflow scheme

Set issue types for workflow in workflow scheme