{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Workflow Transition Properties API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Workflow Transition Properties", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Workflow Transition Properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/rest/api/3/workflow/transitions/:transitionId/properties", "params": [ { "name": "transitionId", "value": "", "type": "path", "description": "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." }, { "name": "includeReservedKeys", "value": "", "type": "query", "description": "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*." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "workflowName", "value": "", "type": "query", "description": "The name of the workflow that the transition belongs to." }, { "name": "workflowMode", "value": "", "type": "query", "description": "The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows." } ] }, "docs": "Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Create Workflow Transition Property", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/rest/api/3/workflow/transitions/:transitionId/properties", "params": [ { "name": "transitionId", "value": "", "type": "path", "description": "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." }, { "name": "key", "value": "", "type": "query", "description": "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." }, { "name": "workflowName", "value": "", "type": "query", "description": "The name of the workflow that the transition belongs to." }, { "name": "workflowMode", "value": "", "type": "query", "description": "The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, { "info": { "name": "Atlassian Update Workflow Transition Property", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/rest/api/3/workflow/transitions/:transitionId/properties", "params": [ { "name": "transitionId", "value": "", "type": "path", "description": "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." }, { "name": "key", "value": "", "type": "query", "description": "The key of the property being updated, also known as the name of the property. Set this to the same value as the `key` defined in the request body." }, { "name": "workflowName", "value": "", "type": "query", "description": "The name of the workflow that the transition belongs to." }, { "name": "workflowMode", "value": "", "type": "query", "description": "The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).

**[Permissions](#permissions) required:**" }, { "info": { "name": "Atlassian Delete Workflow Transition Property", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/rest/api/3/workflow/transitions/:transitionId/properties", "params": [ { "name": "transitionId", "value": "", "type": "path", "description": "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." }, { "name": "key", "value": "", "type": "query", "description": "The name of the transition property to delete, also known as the name of the property." }, { "name": "workflowName", "value": "", "type": "query", "description": "The name of the workflow that the transition belongs to." }, { "name": "workflowMode", "value": "", "type": "query", "description": "The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited." } ] }, "docs": "Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } ] } ], "bundled": true }