Variable replacements
| Variable | Replacement | Since |
|---|---|---|
| project | Last created or referenced project key | |
| projectId | Last created or referenced project id (numeric) | |
| projectUrl | Last created or referenced project URL | 8.4 |
| repository | Last created or referenced repository slug | |
| repositoryId | Last created or referenced repository id (numeric) | |
| repositoryUrl | Last created or reference repository URL | 8.4 |
| repositoryName | Last created or referenced repository name | 8.4 |
| repositoryUrl | Last created or referenced repository URL | 8.4 |
| pullRequest | Last created or referenced pull request name | |
| pullRequestId | Last created or referenced pull request id (numeric) | |
| pullRequestUrl | Last created or referenced pull request URL | 8.4 |
| branch | Last created or referenced branch name | |
| branchId | Last created or referenced branch id (numeric) | |
| restriction | Last reference branch restriction type | |
| restrictionId | Last created or referenced branch restriction id | |
| matchingType | Last referenced branch restriction matching type | |
| matchingId | Last referenced branch restriction matching id | |
| commitId | Last referenced commit id | |
| commitAuthorId | Last referenced commit author id | |
| hook | Last referenced hook key | 11.0 |
| hookName | Last referenced hook name | 11.0 |
| hookConfiguration | Last referenced hook configuration (with outputFormat 2) | 11.0 |
| sshKeyId | Last created SSH key id (numeric) | |
| group | Last reference group name | |
| userId | Last referenced user id | 9.3 |
| userKey | Last referenced user key (numeric id) | 9.3 |
| userDisplayName | Last referenced user display name | 9.3 |
| applicationLink | Last referenced application link name | 8.7 |
| applicationLinkId | Last referenced application link id | 7.7 |
| applicationLinkUrl | Last referenced application link URL | 8.7 |
| path | Last referenced path | 9.8 |
| pathId | Last referenced path id | 9.8 |
| revision | Last referenced revision | 9.8 |
| type | Last referenced file type (FILE or DIRECTORY) | 9.8 |
| downloadUrl | Last referenced download url | 9.8 |
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.
| Variable | Replacement | Since |
|---|---|---|
| project | Last created or referenced project key | |
| projectId | Last created or referenced project id (numeric) | |
| projectUrl | Last created or referenced project URL | 8.4 |
| repository | Last created or referenced repository slug | |
| repositoryId | Last created or referenced repository id (numeric) | |
| repositoryUrl | Last created or reference repository URL | 8.4 |
| repositoryName | Last created or referenced repository name | 8.4 |
| repositoryUrl | Last created or referenced repository URL | 8.4 |
| pullRequest | Last created or referenced pull request name | |
| pullRequestId | Last created or referenced pull request id (numeric) | |
| pullRequestUrl | Last created or referenced pull request URL | 8.4 |
| branch | Last created or referenced branch name | |
| branchId | Last created or referenced branch id (numeric) | |
| restriction | Last reference branch restriction type | |
| restrictionId | Last created or referenced branch restriction id | |
| matchingType | Last referenced branch restriction matching type | |
| matchingId | Last referenced branch restriction matching id | |
| commitId | Last referenced commit id | |
| commitAuthorId | Last reference commit author id | |
| sshKeyId | Last created SSH key id (numeric) | |
| group | Last reference group name | |
| userId | Last referenced user id | 9.3 |
| userKey | Last referenced user key (numeric id) | 9.3 |
| userDisplayName | Last referenced user display name | 9.3 |
| applicationLink | Last referenced application link name | 8.7 |
| applicationLinkId | Last referenced application link id | 7.7 |
| applicationLinkUrl | Last referenced application link URL | 8.7 |
| path | Last referenced path | 9.8 |
| pathId | Last referenced path id | 9.8 |
| revision | Last referenced revision | 9.8 |
| type | Last referenced file type (FILE or DIRECTORY) | 9.8 |
| downloadUrl | Last referenced download url | 9.8 |
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.
Log a request with our support team.
Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.