Variable replacements

VariableReplacementSince
projectLast created or referenced project key
projectIdLast created or referenced project id (numeric)
projectUrlLast created or referenced project URL8.4
repositoryLast created or referenced repository slug
repositoryIdLast created or referenced repository id (numeric)
repositoryUrlLast created or reference repository URL8.4
repositoryNameLast created or referenced repository name8.4
repositoryUrlLast created or referenced repository URL8.4
pullRequestLast created or referenced pull request name
pullRequestIdLast created or referenced pull request id (numeric)
pullRequestUrlLast created or referenced pull request URL8.4
branchLast created or referenced branch name
branchIdLast created or referenced branch id (numeric)
restrictionLast reference branch restriction type
restrictionIdLast created or referenced branch restriction id
matchingTypeLast referenced branch restriction matching type
matchingIdLast referenced branch restriction matching id
commitIdLast referenced commit id
commitAuthorIdLast referenced commit author id
hookLast referenced hook key11.0
hookNameLast referenced hook name11.0
hookConfigurationLast referenced hook configuration (with outputFormat 2)11.0
sshKeyIdLast created SSH key id (numeric)
groupLast reference group name
userIdLast referenced user id9.3
userKeyLast referenced user key (numeric id)9.3
userDisplayNameLast referenced user display name9.3
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id7.7
applicationLinkUrlLast referenced application link URL8.7
pathLast referenced path9.8
pathIdLast referenced path id9.8
revisionLast referenced revision9.8
typeLast referenced file type (FILE or DIRECTORY)9.8
downloadUrlLast referenced download url 9.8


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
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.  

VariableReplacementSince
projectLast created or referenced project key
projectIdLast created or referenced project id (numeric)
projectUrlLast created or referenced project URL8.4
repositoryLast created or referenced repository slug
repositoryIdLast created or referenced repository id (numeric)
repositoryUrlLast created or reference repository URL8.4
repositoryNameLast created or referenced repository name8.4
repositoryUrlLast created or referenced repository URL8.4
pullRequestLast created or referenced pull request name
pullRequestIdLast created or referenced pull request id (numeric)
pullRequestUrlLast created or referenced pull request URL8.4
branchLast created or referenced branch name
branchIdLast created or referenced branch id (numeric)
restrictionLast reference branch restriction type
restrictionIdLast created or referenced branch restriction id
matchingTypeLast referenced branch restriction matching type
matchingIdLast referenced branch restriction matching id
commitIdLast referenced commit id
commitAuthorIdLast reference commit author id
sshKeyIdLast created SSH key id (numeric)
groupLast reference group name
userIdLast referenced user id9.3
userKeyLast referenced user key (numeric id)9.3
userDisplayNameLast referenced user display name9.3
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id7.7
applicationLinkUrlLast referenced application link URL8.7
pathLast referenced path9.8
pathIdLast referenced path id9.8
revisionLast referenced revision9.8
typeLast referenced file type (FILE or DIRECTORY)9.8
downloadUrlLast referenced download url 9.8


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
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.