How to use replacement variables
- Bob Swift
- Elena Amandola (Deactivated)
- Smita Nair
- Michael Kuhl
Owned by Bob Swift
On this page
Description
When running a series of actions using one of the run actions (like run, runFromList, runFromSql, runFromCsv, or a client specific run action), it may be necessary to have a variable reference to information that is generated as a result of actions chosen. This page describes how that works. The specific variables that are available depend on the actions run and the release version of the client. Later versions have expanded on the variables available and new requirements will lead to additional variables. Raise an issue if a new variable is needed or there are actions that could set variables that currently do not.
Reference parameter
Variable references always refer to the last referenced value. For more complex scripting needs, the reference parameter provides a way to remember a specific value even after it may be updated with similar actions that followed the original action. For example remembering a Jira issue key needed for issue linking.
Details
Prior to the action being run, certain substitutions are done on the text. The syntax is @<variable>@. A simple example is @entry@ being replaced with the list entry on the runFromList action.
Example: runFromList
jira --action runFromList --list PROJECTA,PROJECTB --common '--action getProject --project @entry@'
Other variables that are available are generally client specific variables. Here is a Jira example:
Example: runFromProjectList
jira --action runFromProjectList --common '--action getProject --project @project@'
In some cases, the running of client specific actions produce variables replacements that can be used in subsequent actions. How to create projects or sets of issues based on a template provides an example of this.
Jira
| 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.
Jira Service Management
| Variable | Replacement | Since |
|---|---|---|
| project | Last created, found, or referenced project key | 8.8 |
| projectId | Last created, found, or referenced project id | |
| serviceDesk | Last created or referenced service desk name | |
| serviceDeskId | Last created or referenced service desk id | |
| organization | Last created or referenced organization name | |
| organizationId | Last created or referenced organization id | |
| request | Last created or referenced request key | |
| requestId | Last created or referenced request id |
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.
Jira Agile
| Variable | Replacement | Since |
|---|---|---|
| board | Last created, found, or referenced board name | 7.8 |
| boardId | Last created, found, or referenced board id (numeric) | 7.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.
Jira Tempo
| Variable | Replacement | Since |
|---|---|---|
| account | Last referenced account key | 7.3 |
| accountId | Last referenced account id (numeric) | 7.3 |
| accountName | Last referenced account name | 7.3 |
| accountLinkId | Last reference account link id | 7.3 |
| category | Last reference category key | 7.2 |
| categoryId | Last referenced category id (numeric) | 7.3 |
| categoryName | Last referenced category name | 7.2 |
| customer | Last referenced customer key | 7.2 |
| customerId | Last referenced customer id (numeric) | 7.2 |
| customerName | Last referenced custom name | 7.2 |
| member | Last referenced member name | 7.2 |
| team | Last referenced team name | 7.2 |
| teamId | Last referenced team id (numeric) | 7.2 |
| worklogId | Last referenced worklog id | 7.3 |
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.
Bitbucket
| 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.
Bitbucket Cloud
| Variable | Replacement | Since |
|---|---|---|
| branch | Last created or referenced branch | 10.0 |
| commit | Last referenced commit id | 10.0 |
| commitMessage | Last referenced commit message | 10.0 |
| deployment | Last referenced deployment key | 10.0 |
| deploymentName | Last referenced deployment name | 10.0 |
| deploymentUuid | Last referenced deployment UUID | 10.0 |
| pullRequest | Last referenced pull request id | 10.0 |
| pullRequestName | Last referenced pull request name (title) | 10.0 |
| project | Last created or referenced project key | 9.3 |
| projectUuid | Last created or referenced project UUID | 9.3 |
| projectName | Last created or referenced project name | 9.3 |
| pipeline | Last started or referenced pipeline number | 10.0 |
| pipelineState | Last referenced pipeline state | 10.0 |
| pipelineResult | Last referenced pipeline result | 10.0 |
| pipelineUrl | Last referenced pipeline URL | 10.3 |
| pipelineUuid | Last referenced pipeline UUID | 10.2 |
| pipelineCache | Last referenced pipeline cache name | 10.4 |
| pipelineCacheUuid | Last referenced pipeline cache UUID | 10.4 |
| pipelineCacheUrl | Last referenced pipeline cache archive URL | 10.4 |
| stepName | Last referenced pipeline step name | 10.4 |
| stepUuid | Last referenced pipeline step UUID | 10.4 |
| stepState | Last referenced pipeline state | 10.4 |
| stepResult | Last referenced pipeline result | 10.4 |
| runner | Last reference runner name | 10.0 |
| runnerUuid | Last reference runner uuid | 10.0 |
| runnerType | Last reference runner type | 11.1 |
| runnerLabels | Last reference runner labels | 10.0 |
| runnerOauthClientId | Last reference runner oath client id | 11.1 |
| runnerOauthClientSecret | Last added runner oauth client secret
| 11.1 |
| repository | Last referenced repository key | 10.0 |
| repositoryFullKey | Last referenced repository full key | 10.0 |
| repositoryName | Last referenced repository name | 10.0 |
| repositoryUuid | Last referenced repository UUID | 10.0 |
| userId | Last referenced user name | 10.0 |
| userKey | Last referenced user key | 10.0 |
| userDisplayName | Last referenced user display name | 10.0 |
| userUuid | Last referenced user UUID | 10.0 |
| workspace | Last referenced workspace key | 10.0 |
| workspaceName | Last referenced workspace name | 10.0 |
| workspaceUuid | Last referenced workspace UUID | 10.0 |
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.
Confluence
| Variable | Replacement | Since |
|---|---|---|
| pageId | Last created or referenced page id (numeric) | |
| pageUrl | Last created or referenced page url | |
| blogId | Last created blog id (numeric) | |
| blogUrl | Last created or referenced blog url | |
| contentId | Last referenced content id (numeric) | 5.3 |
| contentUrl | Last referenced content URL | |
| containerId | Last referenced container id (numeric) | 9.2 |
| space | Last created or referenced space key | |
| spaceName | Last created or reference space name | 5.2 |
| spaceUrl | Last created or referenced space URL | 8.4 |
| title | Last created referenced title | |
| attachment | Last created or referenced attachment name | |
| attachmentId | Last created or referenced attachment id (numeric) | |
| attachmentUrl | Last created or referenced attachment URL | 8.4 |
| userId | Last created or referenced user id | 5.7, 9.0 |
| userKey | Last created or referenced user key | 8.6, 9.0 |
| userDisplayName | Last created or referenced user display name | 9.0 |
| question | Last created or referenced question | |
| questionId | Last created or reference question id (numeric) | |
| topic | Last created or referenced topic | |
| topicId | Last created or referenced topic id (numeric) | |
| storageFormat | Converted data from last convertToStorageFormat | |
| content | Content source from last getPageSource | 6.3 |
| commentId | Last referenced comment id on runFromCommentList | 6.6 |
| group | Last referenced group name | 6.9 |
| shortcut | Last created or referenced shortcut name | 7.0 |
| shortcutId | Last created or referenced shortcut id (numeric) | 7.0 |
| shortcutUrl | Last referenced shortcut URL | 8.4 |
| applicationLink | Last referenced application link name | 8.7 |
| applicationLinkId | Last referenced application link id | 7.7 |
| applicationLinkUrl | Last referenced application link URL | 8.7 |
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.
Slack
| Variable | Replacement | Since |
|---|---|---|
| channel | Channel name added or referenced | |
| channelId | Channel id added or referenced | |
| messageId | Message id for last sendMessage action or referenced message | 9.5 |
| messageIdList | Comma separated list of message ids for last sendMessage action. Only differs from messageId when autoSplit is used and multiple messages needed to be sent to complete the request. | 9.5 |
| file | file name for the last shared file added or referenced | 10.4 |
| fileId | file id for the last shared file added or referenced | 10.4 |
| user | Current user available from getServerInfo | 10.4 |
| userId | Current userId available from getServerInfo | 10.4 |
| team | Current team available from getServerInfo | 10.4 |
| teamId | Current teamId available from getServerInfo | 10.4 |
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.
Trello
| Variable | Replacement | Since |
|---|---|---|
| board | Last added or referenced board | |
| boardId | Last added or referenced board id | |
| boardUrl | Last added or referenced board URL | 8.4 |
| team | Last added or referenced team | |
| teamId | Last added or referenced team id | |
| teamUrl | Last added or referenced team URL | 8.4 |
| member | Last referenced team member | |
| memberId | Last referenced team member id | |
| memberUrl | Last referenced team member URL | 8.4 |
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.
Bamboo
| Variable | Replacement | Since |
|---|---|---|
| project | Last created or referenced project key | 4.3 |
| projectName | Last created or referenced project name | 4.3 |
| plan | Last created or referenced plan key (2 part key) | 4.3 |
| planShortKey | Last created or reference plan short key (1 part key) | 9.8 |
| planName | Last created or referenced plan name | 4.3 |
| stage | Last added or referenced stage name | 4.3 |
| stageId | Last referenced stage id (numeric) | 4.3 |
| job | Last added or referenced job key (1 part key) | 4.3 |
| jobName | Last added or referenced job name | 4.3 |
| build | Last referenced or queued build key | 9.0 |
| buildNumber | Last referenced or queued build number | 9.3 |
| buildState | Last referenced or queued (with wait) build state | 9.3 |
| artifact | Last added artifact definition name | 4.3 |
| repository | Last added or reference repository name | 4.3 |
| repositoryId | Last added or reference repository id (numeric) | 4.3 |
| agent | Last added or reference agent name | 4.3 |
| agentId | Last referenced agent id | 4.3 |
| assignment | Last referenced agent assignment name | 6.8 |
| assignmentId | Last referenced agent assignment id | 6.8 |
| assignmentKey | Last referenced agent assignment key | 6.8 |
| trigger | Last referenced trigger name | 7.0 |
| triggerId | Last referenced trigger id (numeric) | 7.0 |
| userId | Last referenced user id | 7.4 |
| applicationLink | Last referenced application link name | 8.7 |
| applicationLinkId | Last referenced application link id | 7.7 |
| applicationLinkUrl | Last referenced application link URL | 8.7 |
| capability | Last referenced capability name | 7.9 |
| capabilityKey | Last referenced capability key | 7.9 |
| capabilityGroup | Last referenced capability group | 7.9 |
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.
System
| Variable | Replacement | Since |
|---|
How to use replacement variables
Referenced usually refers to usage from one of the runFrom actions.
Web
Unable to render {include} The included page could not be found.
Marketplace
| Variable | Replacement | Since |
|---|---|---|
| vendor | Last created or referenced vendor id (numeric) | |
| vendorName | Last created or referenced vendor name | |
| app | Last created or referenced app key | |
| appName | Last created or referenced app name | |
| Deprecated 8.6 - use app, removed 9.0 | ||
| Deprecated 8.6 - use appName, removed 9.0 | ||
| reviewId | Last referenced review id | 9.2 |
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.
CSV
None at this time.