admGetScreenFields

Owned by Tim Reiking
Last updated: Oct 22, 2021 by Jonathan Muse
1 min read

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !

Availability

This routine is available starting with SIL Engine 4.8.0.8.

Syntax

admGetScreenFields(screenName)

Description

Retrieves a list of all field information for a provided screen.

Parameters

Parameter name

Type

Required

Description

screenName

string

true

The name of the screen to examine.

Return type

JScreenField[] 

A list of fields, and metadata (id, name, tab, position), related to a provided screen.

Example

JScreenField[] jsf = admGetScreenFields("EM: Scrum Bug Screen");
return jsf;

// String representation
// summary|Summary|0|Field Tab|0|issuetype|Issue Type|1|Field Tab|0|reporter|Reporter|2|Field Tab|0|components|Component/s|3|Field Tab|0|description|Description|4|Field Tab|0|fixVersions|Fix Version/s|5|Field Tab|0|priority|Priority|6|Field Tab|0|labels|Labels|7|Field Tab|0|security|Security Level|8|Field Tab|0|environment|Environment|9|Field Tab|0|attachment|Attachment|10|Field Tab|0|versions|Affects Version/s|11|Field Tab|0|issuelinks|Linked Issues|12|Field Tab|0|assignee|Assignee|13|Field Tab|0|customfield_10102|Epic Link|14|Field Tab|0|customfield_10101|Sprint|15|Field Tab|0

// JSON representation
/*
[{
 "fieldId": "summary",
 "fieldName": "Summary",
 "fieldPosition": 0,
 "tabName": "Field Tab",
 "tabPosition": 0
}, {
 "fieldId": "issuetype",
 "fieldName": "Issue Type",
 "fieldPosition": 1,
 "tabName": "Field Tab",
 "tabPosition": 0
}, {
 "fieldId": "customfield_10102",
 "fieldName": "Epic Link",
 "fieldPosition": 14,
 "tabName": "Field Tab",
 "tabPosition": 0
}]
*/