Scripted Field Snippets

JMCF for Jira Cloud provides several code snippets for Scripted Fields; these snippets address many of the most common data access scenarios and are designed so that they can be modified to fit your needs. To access the snippets, click the Snippets button on the right side of the script editor; you can scroll through the list of snippets here and insert the code by clicking on the snippet you want to use.

You are viewing the documentation for Jira Cloud.

Be sure to review the snippet code you choose! Many of the snippets require you to enter specific values, such as field IDs, project IDs, or user IDs.

Note: Snippets are not fully functional scripted fields! They are pieces of code designed to assist in addressing common data access tasks and calculations.

https://fast.wistia.com/embed/medias/8yrpvbz2pf.jsonp

The following snippets are available:

Snippet Name	Description	Related APIs

Snippet Name	Description	Related APIs
Get field value	Get the value of a field (“Description” by default). Update the ID of the field to customize; see Determining custom field IDs below for details on how to find field IDs.	getField
Get property value	Get the value of a property. Update the name of the property to customize.	getProperty
Get a group	Get the ID of a group using its name.	getGroup
Get the members of a group	Get a collection of User objects.	getGroupUsers
Get a project	Get a project object using the project ID. Update the ID to customize.	getProject
Get projects	Get an array of project objects using an array of project IDs. Update the IDs to customize.	getProjects
Get a user	Get a User object with a User ID. Update the ID to customize; see Determining User IDs below for details on how to find Jira User IDs.	getUser
Get statuses	Get an array of status objects using an array of status ID values. Update the IDs to customize; see Determining status IDs below for details on how to find status ID values.	getStatuses
Get all permissions	Get an array of all permissions as objects.	getAllPermissions
Get permissions		getPermissions
Remaining story points in an epic	This snippet calculates the total Story points for any unfinished child issues for an Epic.	getChildIssues getFields
Completed story points in an epic	This snippet calculates the total Story points for all finished child issues for an Epic.	getChildIssues getFields
Time in each status - getFieldHistory() example	This snippet returns a JSON string of all of the changes for an issue’s Status field.	getField getFieldHistory
Updates per user - getIssueHistory() example	This snippet returns a JSON string of the number of changes each user made to an issue.	getIssueHistory
Due date countdown (duration in seconds)	This snippet calculates the number of seconds remaining until the Due Date.	getField

Scripted Field Snippets

Determining custom field IDs

Determining User IDs

Determining status IDs