Predefined structure types reference

This article provides a comprehensive reference of predefined structure types in Simple Issue Language (SIL), detailing their fields, data types, and the specific functions that return them when working with Jira, Jira Software, and Jira Service Management.

SIL provides two categories of structure types:

Predefined structures are built-in structure types that come with SIL and are designed to interface with specific Jira functionalities. Each predefined structure maps to a corresponding Jira object model and is used by specific SIL functions for operations like HTTP requests, workflow management, and issue tracking.
Custom structures are structure types you can create to model custom data relationships and organize complex data. Custom structures follow the same syntax rules as predefined structures and can be created using the structure definition syntax detailed in the Structures section on the Syntax and types introduction page.

On this page: 1 How to use the reference tables 2 Standard types 3 Jira Software types 4 Jira Service Management types

All structures in SIL operate in a detached state, meaning that modifying structure fields only exists within your script. The changes don't get saved to Jira. For example, if you modify fields in a project version structure, the actual project version in Jira remains unchanged. This makes it safe to manipulate structure data in your scripts without affecting the real Jira data.

How to use the reference tables

This page provides a full list of the predefined structures used in SIL. Here’s a breakdown of the information you can find in the tables:

Table column	Description

Table column	Description
Name	This is the unique identifier for the structure type.
Fields	These are named properties that hold data within the structure.
Field types	The data type for each field. Can be one of the following: Basic types (`string`, `number`, `integer`, `boolean`, `date`) Arrays (marked with `[]`) Other structure types (like a field of type HttpHeader in HttpRequest)
Returned by function	Predefined structures serve as return types for specific SIL functions. When you call these functions, they return data organized in the corresponding structure format.

Example

This is example shows the JComment structure, which has seven fields of string and date type.

struct JComment {
    string id;            // Field name: id, Type: string
    string text;          // Field name: text, Type: string 
    string author;        // Field name: author, Type: string
    date created;         // Field name: created, Type: date
    string updatedBy;     // Field name: updatedBy, Type: string
    date updated;         // Field name: updated, Type: date
    string securityLevel; // Field name: securityLevel, Type: string
}This page provides a reference of the predefined structure types used in SIL.

The JComment structure is returned when you use functions like:

editComment()
getCommentById()
getLastComment()

This means when you write:

JComment comment = getCommentById("12345");

The function returns the comment data organized in the JComment structure, allowing you to access fields like comment.text or comment.author.

Standard types

Standard structure types are core structures that handle fundamental Jira operations and integrations. These include HTTP communication, email handling, user management, comments, custom fields, project components, and other basic Jira entities. These structures are available in all Jira installations and form the foundation of SIL scripting.

Name	Fields	Field types	Returned by function

Name	Fields	Field types	Returned by function
HttpRequest	headers	HttpHeader []	httpDelete httpGet httpOptions	httpPatch httpPost httpPut
	cookies	HttpCookie []
	parameters	HttpQueryParam []
HttpHeader	key	string	httpCreateHeader httpBasicAuthHeader
HttpHeader	value	string	httpCreateHeader httpBasicAuthHeader
HttpCookie	name	string	httpCreateCookie
HttpCookie	value	string	httpCreateCookie
HttpQueryParam	name	string	httpCreateParameter
HttpQueryParam	value	string	httpCreateParameter
HttpResponseInfo	class	string	httpGetResponseInfo
	statusCode	integer
	errorMessage	string
	reasonPhrase	string
HttpProxy	host	string	httpDelete httpGet httpOptions	httpPatch httpPost httpPut
HttpProxy	port	number	httpDelete httpGet httpOptions	httpPatch httpPost httpPut
JAttachment	id	integer	getAttachmentFromEvent
	author	string
	created	date
	content	string
	filename	string
	mimeType	string
	thumbnail	string
	size	integer
JComment	id	string	editComment getCommentById getLastComment
	text	string
	author	string
	created	date
	updatedBy	string
	updated	date
	securityLevel	string
JComponent	id	number	admGetProjectComponent
	name	string
	description	string
	lead	string
	defaultAssignee	number
JCustomField	id	string	getCustomField getAllCustomFields
	name	string
	type	string
	dataType	string
	orderable	boolean
	searchable	boolean
JCustomFieldOption	id	string	admAddCustomFieldOptions admDeleteCustomFieldOptions admGetCustomFieldOptions admUpdateCustomFieldOptions
	optionId	string
	value	string
	disabled	boolean
JDashboard	id	string	admCopyDashboard admCreateDashboard admGetAllDashboards admGetDashboardById admGetDashboardsByName	admGetDashboardsByOwner admGetDashboardsForUser admGetFavouriteDashboards admUpdateDashboard
	name	string
	description	string
	viewUrl	string
	system	boolean
	owner	string
	refreshintegererval	integer
	popularity	integer
	rank	integer
	editPermissions	JSharePermission []
	sharePermissions	JSharePermission []
JEmailAttachment	file	string	sendEmail
	name	string
	mimeType	string
JEmailMessage	to	string []	sendEmail sendHtmlEmail
	cc	string []
	bcc	string []
	subject	string
	message	string
	from	string
		JEmailAttachment []
JFieldChange	user	string	getFieldChanges lastIssueChanges
	changeDate	date
	field	string
	oldVal	string
	newVal	string
	oldValString	string
	newValString	string
JFieldConfigurationScheme	id	integer	admGetAllFieldConfigSchemes admGetFieldConfigScheme
	name	string
	description	string
JFieldConfiguration	id	integer	admGetFieldConfigById admCreateFieldConfig	admUpdateFieldConfig
	name	string
	description	string
	isDefault	boolean
JFieldConfigITMapping	fieldConfigurationId	integer	admGetFieldConfigITMappings
JFieldConfigITMapping	issueTypeId	integer	admGetFieldConfigITMappings
JFieldConfigurationItem	field	string	admGetAllFieldConfigItems
	description	string
	renderer	string
	hidden	boolean
	required	boolean
JFieldValue	fieldName	string	createIssue
JFieldValue	values	string []	createIssue
JFilter	id	integer	admCreateFilter admGetAllFilters admGetAllOwnedFilters admGetFavouriteFilters admGetFilterById	admGetFiltersByName admGetFiltersForProject admUpdateFilter getFilterFromEvent
	jql	string
	name	string
	description	string
	owner	string
	editPermissions	JSharePermission []
	sharePermissions	JSharePermission []
JGadget	id	integer	admAddGadgetToDashboard admGetAvailableGadgets admGetDashboardGadgetById	admGetDashboardGadgets admUpdateGadgetInDashboard
	moduleKey	string
	titlen	string
	uri	string
	color	string
	row	integer
	column	integer
JIssueLink	id	number	getIssueLinksDetail
	name	string
	direction	number
	description	string
	issue	string
JIssueNotificationScheme	id	integer	admGetAllNotificationSchemes admGetNotificationScheme
	name	string
	description	string
JIssueNotificationSchemeEvent	event	string	admGetAllNotificationSchemes	admGetNotificationScheme
JIssueNotificationSchemeEvent	notifications	JIssueNotificationSchemeNotificationDetail []	admGetAllNotificationSchemes	admGetNotificationScheme
JIssueNotificationSchemeNotificationDetail	notificationType	string	admGetAllNotificationSchemes	admGetNotificationScheme
JIssueNotificationSchemeNotificationDetail	parameter	string	admGetAllNotificationSchemes	admGetNotificationScheme
JIssueNotificationSchemeProjectMapping	notificationSchemeId	integer	admGetNotificationProjectMappings
JIssueNotificationSchemeProjectMapping	projectId	integer	admGetNotificationProjectMappings
JIssueSecurityScheme	id	integer	admGetAllIssueSecuritySchemes admGetIssueSecurityScheme
	defaultSecurityLevelId	integer
	name	string
	description	string
JIssueTypeScheme	id	integer	admGetAllIssueTypeSchemes admGetIssueTypeScheme
	name	string