API for Velocity Context Objects
Last updated
Was this helpful?
Last updated
Was this helpful?
Velocity Context offers many objects for templates. Find the list of variables with explanations here: .
Below is the detailed description of object attributes. You can render the attributes in the templates in the format of $!variable.attribute
Attribute Name
Type
Description
String
Internal key of the user it is unique to the users.
String
Loginname of the user
String
Email address of the user
String
Display name of the user
boolean
true if the user account is active in Jira
String
URLs to user avatars in different sizes.
Attribute Name
Type
Description
id
number
Internal ID of the issue
key
String
Unique Issue Key
summary
String
Issue summary
description
Issue Description field with raw value and rendered format
environment
Issue Environment field with raw value and rendered format
project
Project of the issue
issueType
Type of the issue
status
Issue status
resolution
Resolution of the issue
priority
Priority of the issue
timetracking
Timetracking details of the issue
creator
Creator of the issue. The Creater may be different from the Reporter as privileged users may create issues on behalf of others.
reporter
The user set as Reporter in the issue.
assignee
Current assignee.
created
Issue Created date field value with raw value and rendered format.
updated
Issue Updated date field value with raw value and rendered format.
resolutionDate
Issue Resolution date field value with raw value and rendered format.
dueDate
Issue Due Date field value with raw value and rendered format.
customFields
comments
attachments
components
fixVersions
affectsVersions
labels
Signature
Return type
Parameters
Description
Example
getCustomFieldValue(customFieldKey)
customFieldKey: key of the custom field
$!issue.getCustomFieldValue('customfield_10116')
Attribute Name
Type
Description
eventType
The type of the triggered event.(eg. issue created, issue commented, ...)
issue
The Issue which the event was fired on.
changelog
worklog
comment
timestamp
Date
The time when the issue was triggered
user
The user who triggered the event (added the comment, updated the issue, ...)
Attribute Name
Type
Description
id
Number
Internal ID of the comment
author
Author of the comment
updateAuthor
Update author of the comment
body
Comment body
created
Creation date
updated
Update date
limitedVisibility
boolean
internalServiceDeskComment
boolean
publicServiceDeskComment
boolean
Attribute Name
Type
Description
items
A list of Changelog items
Attribute Name
Type
Description
created
field
fieldId
fieldType
from
fromString
to
toString
Attribute Name
Type
Description
author
Author of the worklog
comment
The comment added to the worklog
created
The date when the worklog was created
issueId
long
Id of the issue
started
timeSpent
String
timeSpentSeconds
long
visibilityType
String
visibilityValue
String
updateAuthor
updated
Attribute Name
Type
Description
Attribute Name
Type
Description
boolean
Returns true if the given user is an agent on the project, otherwise false.
Attribute Name
Type
Description
Attribute Name
Type
Description
customField
Reference to the CustomField
renderedValue
String
The value in html as visible in Jira
value
T
Contains the raw value of the field.
Type is the type of declared in Jira. One of
Date
String
User
Collection<User>
Attribute Name
Type
Description
customId
String
key of the custom field. This is the primary identifier used by Email This Issue. (eg. in macro parameters)
The format is customfield_$id.
itemType
String
type
String
Attribute Name
Type
Description
rawValue
T
Contains the raw value of the field.
Type is the type of declared in Jira. One of
Date
String
User
Collection<User>
renderedValue
String
The value in html as visible in Jira
<String>
<String>
<Date>
<Date>
<Date>
<Date>
<>
<>
<>
<>
<>
<>
<String>
Returns a object representing the value of the custom field addressed by the key
<String>
<Date>
<Date>
List<>
<String>
<Date>
<Date>
<Date>
ong