API for Velocity Context Objects - 1.7

Velocity Context offers many objects for templates. Find the list of variables with explanations here: Customizable Email Templates.
Below is the detailed description of object attributes. You can render the attributes in the templates in the format of $!variable.attribute
​User​
​Issue​
​Attributes​
​Methods​
​IssueEvent​
​Comment​
​Changelog​
​ChangelogItem​
​Worklog​
​EmailCommand​
​Template Support​
​Project​
​IssueType​
​Status​
​Priority​
​Resolution​
​Timetracking​
​Attachment​
​Component​
​Version​
​CustomFieldValue​
​CustomField​
​FieldValue<T>​
User
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.
Issue
Attributes
Attribute Name
Type
Description
id
number
Internal ID of the issue
key
String
Unique Issue Key
summary
String
Issue summary
description
FieldValue<String>
Issue Description field with raw value and rendered format
environment
FieldValue<String>
Issue Environment field with raw value and rendered format
project
Project
Project of the issue
issueType
IssueType
Type of the issue
status
Status
Issue status
resolution
Resolution
Resolution of the issue
priority
Priority
Priority of the issue
timetracking
Timetracking
Timetracking details of the issue
creator
User
Creator of the issue. The Creater may be different from the Reporter as privileged users may create issues on behalf of others.
reporter
User
The user set as Reporter in the issue.
assignee
User
Current assignee.
created
FieldValue<Date>
Issue Created date field value with raw value and rendered format.
updated
FieldValue<Date>
Issue Updated date field value with raw value and rendered format.
resolutionDate
FieldValue<Date>
Issue Resolution date field value with raw value and rendered format.
dueDate
FieldValue<Date>
Issue Due Date field value with raw value and rendered format.
customFields
Collection<CustomFieldValue>
​
Methods
Signature
Return type
Parameters
Description
Example
getCustomFieldValue(customFieldKey)
CustomFieldValue
customFieldKey: key of the custom field
Returns a API for Velocity Context Objects - CustomFieldValue object representing the value of the custom field addressed by the key
$!issue.getCustomFieldValue('customfield_10116')
IssueEvent
Attribute Name
Type
Description
eventType
​
The type of the triggered event.(eg. issue created, issue commented, ...)
issue
​API for Velocity Context Objects#Issue​
The Issue which the event was fired on.
changelog
​API for Velocity Context Objects#Changelog​
​
worklog
​API for Velocity Context Objects#Worklog​
​
comment
​API for Velocity Context Objects#Comment​
​
timestamp
Date
The time when the issue was triggered
user
​API for Velocity Context Objects#User​
The user who triggered the event (added the comment, updated the issue, ...)
Comment
Attribute Name
Type
Description
id
Number
Internal ID of the comment
author
User
Author of the comment
updateAuthor
User
Update author of the comment
body
FieldValue<String>
Comment body
created
FieldValue<Date>
Creation date
updated
FieldValue<Date>
Update date
limitedVisibility
boolean
​
internalServiceDeskComment
boolean
​
publicServiceDeskComment
boolean
​
Changelog
Attribute Name
Type
Description
items
List<API for Velocity Context Objects#ChangelogItem>
A list of Changelog items
ChangelogItem
Attribute Name
Type
Description
created
​
​
field
​
​
fieldId
​
​
fieldType
​
​
from
​
​
fromString
​
​
to
​
​
toString
​
​
Worklog
Attribute Name
Type
Description
author
​API for Velocity Context Objects#User​
Author of the worklog
comment
​FieldValue<String>
The comment added to the worklog
created
​FieldValue<Date>
The date when the worklog was created
issueId
long
Id of the issue
started
​FieldValue<Date>
​
timeSpent
String
​
timeSpentSeconds
long
​
visibilityType
String
​
visibilityValue
String
​
updateAuthor
​API for Velocity Context Objects#User​
​
updated
​FieldValue<Date>
​
EmailCommand
Attribute Name
Type
Description
Template Support
Attribute Name
Type
Description
​
boolean
Returns true if the given user is an agent on the project, otherwise false.
Project
Attribute Name
Type
Description
IssueType
Status
Priority
Resolution
Timetracking
Attachment
Component
Version
CustomFieldValue
Attribute Name
Type
Description
customField
API for Velocity Context Objects#CustomField
Reference to the CustomField
renderedValue
String
The value in html as visible in Jira 
value
​
Contains the raw value of the field.
Type is the type of declared in Jira. One of
Date
String
User
Collection<User>
CustomField
Attribute Name
Type
Description
customId
Long
​
​
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
​
FieldValue<T>
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 

General - Previous

API

API for Velocity Context Objects

Last modified 6mo ago