Skip to end of banner
Go to start of banner

Variable Replacements

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Current »


VariableReplacementSince
projectLast created, found, or referenced project key
projectIdLast created, found, or referenced project id (numeric)
projectUrlLast created, found, or referenced project URL 8.4
projectTypeLast created, found, or referenced project type (software, business, service_desk)9.5
projectStyleLast created, found, or referenced project style (classic, next-gen)9.5
issueLast created or referenced issue key (not a subtask)
issueIdLast created or referenced issue id (numeric)
issueUrlLast created or referenced issue URL8.4
subtaskLast created subtask key
subtaskIdLast created subtask id (numeric)
subtaskUrlLast created subtask URL8.4
parentLast referenced parent issue key
parentIdLast referenced parent issue id (numeric)
parentUrlLast referenced parent issue URL 8.4
cloneLast created clone issue key
cloneIdLast created clone issue id (numeric)
cloneUrlLast created clone issue URL8.4
attachmentLast created or referenced attachment name8.4
attachmentIdLast created or referenced attachment id (numeric)8.4
attachmentUrlLast created or referenced attachment URL8.4
attachmentThumbnailUrlLast created or referenced attachment thumbnail URL8.4
versionLast created or referenced version name4.5
versionIdLast created or referenced version id (numeric)4.5
componentLast created or referenced component name4.5
componentIdLast created or referenced component id (numeric)4.5
workflowLast referenced workflow name
groupLast referenced group name4.5
commentIdLast referenced comment id (numeric)5.2
commentBodyLast referenced comment body9.3
commentVisibilityTypeLast referenced comment visibility type9.3
commentVisibilityNameLast referenced comment visibility Name9.3
schemeLast created or referenced scheme name6.0 
schemeIdLast created or referenced scheme id (numeric)5.1
permissionLast added or referenced permission9.3
permissionIdLast added or referenced permissionId9.3
permissionHolderTypeLast added or referenced permission holder type9.3
permissionHolderValueLast added or referenced permission holder value9.3
permissionHolderNameLast added or referenced permission holder name9.3
screenLast referenced screen name6.0
screenIdLast referenced screen id (numeric)5.1
linkTypeLast referenced link type (runFromLinkList)6.3
linkTypeIdLast referenced link type id (runFromLinkList)6.3
linkDescriptionLast referenced link description (runFromLinkList)6.3
linkIdLast referenced link id (runFromLinkList)6.3
fromIssueLast referenced from issue from an issue link (runFromLinkList)6.3
toIssueLast referenced to issue from an issue link (runFromLinkList)6.3
categoryLast added or referenced project category name6.8
categoryIdLast added or referenced project category id (numeric)6.8
roleLast added or referenced project role name6.8
roleIdLast added or referenced project role id6.8
userIdLast created or referenced user id5.7, 9.0
userKeyLast created or referenced user key9.0
userDisplayNameLast created or referenced user display name9.0
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id (numeric)7.7
applicationLinkUrlLast referenced application link URL8.7
remoteLinkLast referenced remote link name9.3
remoteLinkIdLast referenced remote link id (numeric)9.3
remoteLinkUrlLast referenced remote link URL9.3
fieldLast added (custom field) or referenced field id 9.3
fieldNameLast referenced field name9.3
customFieldIdLast added (custom field) or referenced custom field id (numeric)9.3
customFieldTypeLast referenced custom field type9.3
fieldConfigurationLast added or referenced field configuration10.1
fieldConfigurationIdLast added or referenced field configuration id10.1
filterlast added or referenced filter name10.3
filterIdlast added or referenced filter id10.3
<user_defined>
  1. Issue key created in one of the create actions using the reference parameter
  2. Field value in getFieldValue action using the reference parameter
  • variable name is the value of the reference parameter
  • 70858279

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.  

  • No labels