Get workflow transition properties

GET

/rest/api/3/workflow/transitions/{transitionId}/properties

Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.

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/workflow/transitions//properties?workflowName='

Response Example

200 - Success

[{"key":"jira.i18n.title","value":"some.title","id":"jira.i18n.title"},{"key":"jira.permission","value":"createissue","id":"jira.permission"}]

Request

Path Params

transitionId

integer

required

The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.

Query Params

includeReservedKeys

string

optional

Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.

key

string

optional

The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.

workflowName

string

required

The name of the workflow that the transition belongs to.

workflowMode

string

optional

The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.

Responses

🟢200200 response

application/json

Body

Details about the server Jira is running on.

string

read-onlyoptional

The ID of the transition property.

key

string

read-onlyoptional

The key of the transition property. Also known as the name of the transition property.

value

string

required

The value of the transition property.

Additional properties

integer | number | string | boolean

optional

🟠400Returned if the request is invalid.

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

🟠403Returned if the user does not have admin permission

🟠404Returned if the workflow transition or property is not found.

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

Delete workflow transition rule configurations

Update workflow transition property