This page explains how to access the value of Pre-defined custom fields using Groovy. You can access them using the getters of the Issue interface. To understand how to write values into the writable custom fields see Raw value/text input for fields and Groovy expression input for fields.
Note |
---|
'xxxxx ' in the custom fields detailed below is the ID of the custom field. Click here to know how to find the ID of the custom fields. |
...
...
This page explains how to access the value of Pre-defined custom fields using Groovy. You can access them using the getters of the Issue interface. To understand how to write values into the writable custom fields see Raw value/text input for fields and Groovy expression input for fields.
Note |
---|
'xxxxx ' in the custom fields detailed below is the ID of the custom field. Click here to know how to find the ID of the custom fields. |
In this page:
Capture for JIRA fields
Panel |
---|
|
Capture for JIRA Browser |
Panel |
---|
|
Capture for JIRA BrowserDocument Mode |
Panel |
---|
|
Capture for JIRA Document ModejQuery VersionField name: Capture for JIRA Document ModejQuery Version Description: The Capture for JIRA Document Mode jQuery Version field is a multi-line text field describing the document mode jQuery version of the page captured. - Accessing the Capture for JIRA Document Mode fieldjQuery Version field: You can access the Capture for JIRA Document ModejQuery Version field using any of the following methods getters of the Issue interface:
|
Panel |
---|
|
Capture for JIRA jQuery VersionOperating SystemField name: Capture for jQuery VersionJIRA Operating System Description: The Capture for JIRA jQuery Version Operating system field is a multi-line text field describing the jQuery version operating system of the page captured. - Accessing the Capture for JIRA jQuery Version Operating System field: You can access the Capture for JIRA jQuery VersionOperating System field using any of the following getters methods of the Issue interface:
|
Panel |
---|
|
Capture for JIRA Operating SystemScreen ResolutionField name: Capture for JIRA Operating SystemScreen Resolution Description: The Capture for JIRA Operating system Screen Resolution field is a multi-line text field describing the operating system screen resolution of the page capturedcapture. - Accessing the Capture for JIRA Operating System fieldScreen resolution field: You can access the Capture for JIRA Operating SystemScreen Resolution field using any of the following methods of Issue interface:
|
Panel |
---|
|
Capture for JIRA Screen ResolutionURLField name: Capture for JIRA Screen ResolutionURL Description: The Capture for JIRA Screen Resolution URL field is a multistring representation of a multi-line text field describing the screen resolution URL of the page capturecaptured. - Accessing the Capture for Screen resolution JIRA URL field: You can access the Capture for Screen ResolutionJIRA URL field using any of the following methods getters of the Issue interface:
|
Panel |
---|
|
Capture for JIRA URLUser AgentField name: Capture for JIRA URLUser Agent Description: The Capture for JIRA URL User agent field is a string representation of a multimulti-line text field describing the URL user agent of the page captured. - Accessing the Capture for JIRA URL fieldUser Agent field: You can access the Capture for JIRA URLUser Agent field using any of the following getters of the Issue interface:
|
Panel |
---|
|
Capture for JIRA User AgentRaised duringField name: Capture for JIRA User Agent Raised during Description: The Capture for JIRA User agent Raised during field is a multi-line text field describing the user agent of the page capturedstring representing the ID of the session the issue was raised in. - Accessing the Capture for JIRA User Agent Raised during field: You can access the Capture for JIRA User AgentRaised during field using any of the following getters of the Issue interface:
|
Panel |
---|
|
Raised duringTest sessions |
Panel |
---|
|
Test sessionsTesting status |
Jira Software fields
Panel |
---|
|
Testing status Epic Color
Field name: Testing status Epic Color Description: The Testing status Epic Color field is a string representing the status of the all the sessions the issue belongs tomulti-line text field describing the color of the Epic. - Accessing the Testing status field Epic Color field: You can access the Testing statusEpic color field using any of the following getters of the Issue interface:
|
...
Panel |
---|
|
Epic StatusRankField name: Epic Status Rank Description: The Epic Status The Rank field is a multi-line text field string representing the status priority of the Epicissue at a more granular level than issue priorities in Jira. Accessing the Epic Status Rank field: You You can access the Epic statusRank field using any of the following getters of the Issue interface:
|
Panel |
---|
|
RankSprintField name: Rank Sprint Description: The Rank The Sprint field is a string representing the priority of the issue at a more granular level than issue priorities in Jiracollection of objects. Each object represents a Sprint. Accessing the Rank Sprint field: You You can access the Rank Sprint field using any of the following getters of the Issue interface:interface:
|
Jira Service Desk fields
Panel |
---|
|
ApprovalsField name: Approvals Description: The Approvals field is a collection of objects. Each object represents an Approval . Accessing the Approvals field: You can access the Approvals field using get("Approvals").getApprovals() or get("customfield_xxxxx" ) that returns a String with comma separated Sprint IDs).getApprovals() method of the Issue interface that returns a Collection <Approval>
Example: Sprints Approvals on the issue belongs to: Code Block |
---|
language | groovy |
---|
linenumbers | true |
---|
| if(issue. | getAsStringget("Approvals").getApprovals())
{
issue.get(" | Sprint")Approvals").getApprovals().first().getName()
} |
|
Panel |
---|
|
Story PointsApprovers
Field name: Story Points Approvers Description: The Story Points field is a number representing the story pointsApprovers field is an array of objects. Each object represents an ApplicationUser. - Accessing the Story Points Approvers field: You can access the Story points field using any of the following getters of the Issue interface:
get("Story Points") or get("customfield_xxxxx") that returns a Double
Example: Story points of the story: Code Block |
---|
language | groovy |
---|
linenumbers | true |
---|
| issue.get("Story Points") |
Example: Increase the story points by 10: Code Block |
---|
language | groovy |
---|
linenumbers | true |
---|
| if(issue.get("Story Points"))
{
issue.get("Story Points") + 10
} | getAsString("Story Points") or getAsString("the Approvers field using any of the following getters of the Issue interface:
|
Panel |
---|
|
Approvals |
Jira Service Desk fields
Panel |
---|
|
ApproversCustomer Request TypeField name: Approvers Customer Request Type Description: The Approvers Customer Request Type field is represents an array of objects. Each object represents an ApplicationUser. Accessing the Approvers object describing the information about the Service Desk used to create the ticket. - Accessing the Customer request type field: You can access the Approvers Customers Request Type field using any of the following getters of the Issue interface:
get(" ApproversCustomer Request Type") or get("customfield_xxxxx") that returns a Collection <ApplicationUser>: VpOrigin
Example: Names of all approvers who approved the issueCustomer request type: def names = []
Approvers").each(){
names += it.getName()
}
names.join(","Customer Request Type")?.getRequestTypeKey() |
getAsString(" ApproversCustomer Request Type") or getAsString("customfield_xxxxx") that that returns a String with comma separated Approvers usernames String representing the request type name:
Example: Names of all approvers who approved the issueCustomer request type: Code Block |
---|
issue.getAsString( | "Approvers)
|
Panel |
---|
|
Customer Request TypeTo get the Customer Request Type name as displayed on the issue view, you can use the following snippet: Code Block |
---|
language | groovy |
---|
linenumbers | true |
---|
| import com.atlassian.servicedesk.api.requesttype.RequestTypeService
def requestTypeService = getComponent(RequestTypeService)
def sourceIssueRequestTypeQuery = requestTypeService.newQueryBuilder().issue(issue.id).build()
def requestTypeEither = requestTypeService.getRequestTypes(currentUser, sourceIssueRequestTypeQuery)
if (requestTypeEither.isLeft()) {
log.warn "${requestTypeEither.left().get()}"
return false
}
return requestTypeEither.right.results[0].name |
|
...
Panel |
---|
|
SatisfactionField name: Satisfaction Description: The Satisfaction field is an object describing the request feedback in Service Desk requests. Accessing the Satisfaction field: You can access the Satisfaction field using any of the following getters of the Issue interface:
|
...
Panel |
---|
|
Time to resolutionField name: Time to resolution Description: The Time to resolution field is an object representing a SLA value. Accessing the Time to resolution field: You can access the Time to resolution field using any of the following getters of the Issue interface:
|
Portfolio for Jira fields
Panel |
---|
|
Parent Link- Field Name: Parent Link
Description: The Parent link field is an object representing the Initiative of the current Epic. It returns com.atlassian.rm.jpo.env.issues.SimpleIssueAttributes. get("Parent Link") or get("customfield_xxxxx") that returns an Issue Example: Parent Link of the Epic Code Block |
---|
language | groovy |
---|
linenumbers | true |
---|
| issue.get("Parent Link") |
Accessing the Parent Link field: You can access the Parent Link field using any of the following getters of the Issue interface:representing You can access the Parent Link field using getAsString("Parent Link") or getAsString("customfield_xxxxx") that returns a String representing the key of the Initiative the Epic belongs to :.
|
Tempo fields
...