Variable Replacements
Variable | Replacement | Since |
|---|---|---|
project | Last created, found, or referenced project key |
|
projectId | Last created, found, or referenced project id (numeric) |
|
projectUrl | Last created, found, or referenced project URL | 8.4 |
projectType | Last created, found, or referenced project type (software, business, service_desk) | 9.5 |
projectStyle | Last created, found, or referenced project style (classic, next-gen) | 9.5 |
issue | Last created or referenced issue key (not a subtask) |
|
issueId | Last created or referenced issue id (numeric) |
|
issueUrl | Last created or referenced issue URL | 8.4 |
subtask | Last created subtask key |
|
subtaskId | Last created subtask id (numeric) |
|
subtaskUrl | Last created subtask URL | 8.4 |
parent | Last referenced parent issue key |
|
parentId | Last referenced parent issue id (numeric) |
|
parentUrl | Last referenced parent issue URL | 8.4 |
clone | Last created clone issue key |
|
cloneId | Last created clone issue id (numeric) |
|
cloneUrl | Last created clone issue URL | 8.4 |
attachment | Last created or referenced attachment name | 8.4 |
attachmentId | Last created or referenced attachment id (numeric) | 8.4 |
attachmentUrl | Last created or referenced attachment URL | 8.4 |
attachmentThumbnailUrl | Last created or referenced attachment thumbnail URL | 8.4 |
version | Last created or referenced version name | 4.5 |
versionId | Last created or referenced version id (numeric) | 4.5 |
component | Last created or referenced component name | 4.5 |
componentId | Last created or referenced component id (numeric) | 4.5 |
workflow | Last referenced workflow name |
|
group | Last referenced group name | 4.5 |
commentId | Last referenced comment id (numeric) | 5.2 |
commentBody | Last referenced comment body | 9.3 |
commentVisibilityType | Last referenced comment visibility type | 9.3 |
commentVisibilityName | Last referenced comment visibility Name | 9.3 |
scheme | Last created or referenced scheme name | 6.0 |
schemeId | Last created or referenced scheme id (numeric) | 5.1 |
permission | Last added or referenced permission | 9.3 |
permissionId | Last added or referenced permissionId | 9.3 |
permissionHolderType | Last added or referenced permission holder type | 9.3 |
permissionHolderValue | Last added or referenced permission holder value | 9.3 |
permissionHolderName | Last added or referenced permission holder name | 9.3 |
screen | Last referenced screen name | 6.0 |
screenId | Last referenced screen id (numeric) | 5.1 |
linkType | Last referenced link type (runFromLinkList) | 6.3 |
linkTypeId | Last referenced link type id (runFromLinkList) | 6.3 |
linkDescription | Last referenced link description (runFromLinkList) | 6.3 |
linkId | Last referenced link id (runFromLinkList) | 6.3 |
fromIssue | Last referenced from issue from an issue link (runFromLinkList) | 6.3 |
toIssue | Last referenced to issue from an issue link (runFromLinkList) | 6.3 |
category | Last added or referenced project category name | 6.8 |
categoryId | Last added or referenced project category id (numeric) | 6.8 |
role | Last added or referenced project role name | 6.8 |
roleId | Last added or referenced project role id | 6.8 |
userId | Last created or referenced user id | 5.7, 9.0 |
userKey | Last created or referenced user key | 9.0 |
userDisplayName | Last created or referenced user display name | 9.0 |
applicationLink | Last referenced application link name | 8.7 |
applicationLinkId | Last referenced application link id (numeric) | 7.7 |
applicationLinkUrl | Last referenced application link URL | 8.7 |
remoteLink | Last referenced remote link name | 9.3 |
remoteLinkId | Last referenced remote link id (numeric) | 9.3 |
remoteLinkUrl | Last referenced remote link URL | 9.3 |
field | Last added (custom field) or referenced field id | 9.3 |
fieldName | Last referenced field name | 9.3 |
customFieldId | Last added (custom field) or referenced custom field id (numeric) | 9.3 |
customFieldType | Last referenced custom field type | 9.3 |
fieldConfiguration | Last added or referenced field configuration | 10.1 |
fieldConfigurationId | Last added or referenced field configuration id | 10.1 |
filter | last added or referenced filter name | 10.3 |
filterId | last added or referenced filter id | 10.3 |
<user_defined> |
|
|
Common Client Variables
| Variable | Replacement | Since |
|---|---|---|
| entry | Entry being processed from the list parameter of the runFromList action | |
| entry2 | Entry being processed from the list2 parameter of the runFromList action | |
| renderRequest | Last result from the renderRequest action modified by findReplace processing | |
| server | Server URL available for clients accessing a remote server | 9.0 |
| hosting | Available with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values | 9.3 |
| version | Available with getServerInfo for clients accessing a remote server | 9.3 |
| runDate | For run action scripts, it is the client date at the time of the first action referencing the value
| 9.0 |
| file | File path name for last get or get list action that used the file parameter | 9.3 |
| fileSize | File size for the last get or get list action that used the file parameter | 9.3 |
| fileContent | File text content for the last get or get list action that used the file parameter
| 9.3 |
More information
- The syntax is @<variable>@. See How to use replacement variables for more details.
- Variable names are case-sensitive!
- Action help and document lists variables set by specific actions.
- Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
- Last created means the variable is set from the last create or add action.
- Referenced means the variable is set from one of the runFrom or get actions.
- Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
- Within a run script, the setReplacementVariableList action can be used to set custom variables.
- Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
- Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.