Create workflow transition property

Adds a property to 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.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/workflow/transitions//properties?key=&workflowName=' \ --header 'Content-Type: application/json' \ --data-raw '{ "value": "createissue" }'

Request

Path Params

transitionId

integer

required

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

Query Params

key

string

required

The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.

workflowName

string

required

The name of the workflow that the transition belongs to.

workflowMode

string

optional

The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

Body Params application/json

Details about the server Jira is running on.

value

string

required

The value of the transition property.

Additional properties

integer | number | string | boolean

optional

Examples

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 a workflow property with the same key is present on the transition.

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

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

🟠404Returned if the workflow transition is not found.