Predefined Structure Types
Here is a list of predefined structures that are used throughout SIL™, usually with specific routines. Not enough for you? You can also define custom structures. Check our example in the Syntax section and roll your own.
Note that the structure fields can be modified, but the changes are not saved in the database. If you change a field for a project version variable, the project version will not be affected. Simply put, the structures are 'detached'.
Contents
Standard Types
Name | Routine Usage | Field | Type | |
---|---|---|---|---|
HttpRequest | headers | HttpHeader [] | ||
cookies | HttpCookie [] | |||
parameters | HttpQueryParam [] | |||
HttpHeader | key | string | ||
value | string | |||
HttpCookie | name | string | ||
value | string | |||
HttpQueryParam | name | string | ||
value | string | |||
HttpResponseInfo | class | string | ||
statusCode | integer | |||
errorMessage | string | |||
reasonPhrase | string | |||
HttpProxy | host | string | ||
port | number | |||
JAttachment
| id | integer | ||
author | string | |||
created | date | |||
content | string | |||
filename | string | |||
mimeType | string | |||
thumbnail | string | |||
size | integer | |||
JComment | id | string | ||
text | string | |||
author | string | |||
created | date | |||
updatedBy | string | |||
updated | date | |||
securityLevel | string | |||
JComponent | id | number | ||
name | string | |||
description | string | |||
lead | string | |||
defaultAssignee | number | |||
JCustomFieldOption | id | string | ||
optionId | string | |||
value | string | |||
disabled | boolean | |||
JDashboard
| id | string | ||
name | string | |||
description | string | |||
viewUrl | string | |||
system | boolean | |||
owner | string | |||
refreshintegererval | integer | |||
popularity | integer | |||
rank | integer | |||
editPermissions | JSharePermission [] | |||
sharePermissions | JSharePermission [] | |||
JEmailAttachment | file | string | ||
name | string | |||
mimeType | string | |||
JEmailMessage | to | string [] | ||
cc | string [] | |||
bcc | string [] | |||
subject | string | |||
message | string | |||
from | string | |||
| JEmailAttachment [] | |||
JFieldChange | user | string | ||
changeDate | date | |||
field | string | |||
oldVal | string | |||
newVal | string | |||
oldValString | string | |||
newValString | string | |||
JFieldConfigurationScheme | id | integer | ||
name | string | |||
description | string | |||
JFieldConfiguration
| id | integer | ||
name | string | |||
description | string | |||
isDefault | boolean | |||
JFieldConfigITMapping
| fieldConfigurationId | integer | ||
issueTypeId | integer | |||
JFieldConfigurationItem
|
| field | string | |
description | string | |||
renderer | string | |||
hidden | boolean | |||
required | boolean | |||
JFieldValue | fieldName | string | ||
values | string [] | |||
JFilter
| id | integer | ||
jql | string | |||
name | string | |||
description | string | |||
owner | string | |||
editPermissions | JSharePermission [] | |||
sharePermissions | JSharePermission [] | |||
JGadget
| id | integer | ||
moduleKey | string | |||
titlen | string | |||
uri | string | |||
color | string | |||
row | integer | |||
column | integer | |||
JIssueLink | id | number | ||
name | string | |||
direction | number | |||
description | string | |||
issue | string | |||
JIssueNotificationScheme | id | integer | ||
name | string | |||
description | string | |||
JIssueSecurityScheme | id | integer | ||
defaultSecurityLevelId | integer | |||
name | string | |||
description | string | |||
JIssueTypeScheme | id | integer | ||
name | string | |||
description | string | |||
defaultIssueTypeId | integer | |||
JIssueTypeScreenScheme | id | integer | ||
name | string | |||
description | string | |||
JIssueTypeScreenMapping | id | integer | ||
screenSchemeId | integer | |||
JLdapUserAttribute | name | string | ||
value | string [] | |||
JLdapUserStruct | DN | string | ||
attributes | JLdapUserAttribute [] | |||
JPermissionScheme | id | integer | ||
name | string | |||
description | string | |||
JProject | id | number | ||
key | string | |||
name | string | |||
description | string | |||
lead | string | |||
url | string | |||
unassignedByDefault | boolean | |||
category | string | |||
projecttype | string | |||
JProjectIssueTypes | projectKey | string | ||
issueTypesNames | string [] | |||
JPriority
| id | integer | ||
name | string | |||
description | string | |||
iconUrl | string | |||
statusColor | string | |||
isDefault | boolean | |||
JPriorityScheme
| id | integer | ||
name | string | |||
description | string | |||
priorities | string [] | |||
projects | string [] | |||
JRemoteIssueLink
| id | integer | ||
globalId | string | |||
appName | string | |||
relationship | string | |||
iconTitle | string | |||
iconUrl | string | |||
summary | string | |||
title | string | |||
url | string | |||
statusResolved | string | |||
statusIconTitle | string | |||
statusIconUrl | string | |||
statusIconLink | string | |||
JSharePermission
| id | integer | ||
type | string | |||
object | string | |||
JScreen
| id | integer | ||
name | string | |||
description | string | |||
scope | string | |||
projectKey | string | |||
JScreenScheme | id | integer | ||
name | string | |||
description | string | |||
defaultScreenId | integer | |||
createScreenId | integer | |||
editScreenId | integer | |||
viewScreenId | integer | |||
JTeam
|
| id | string | |
name | string | |||
isVisible | boolean | |||
title | string | |||
isShared | boolean | |||
JUser | key | string | ||
|
| |||
username | string | |||
displayname | string | |||
string | ||||
active | boolean | |||
JVersion | id | number | ||
name | string | |||
description | string | |||
projectId | number | |||
startDate | date | |||
releaseDate | date | |||
archived | boolean | |||
released | boolean | |||
JWorkflowScheme | id | integer | ||
name | string | |||
description | string | |||
defaultWorkflow | string | |||
JWorklog | id | number | ||
author | string | |||
startDate | date | |||
timeSpent | integererval | |||
comment | string | |||
issue | string | |||
WebhookParam | name | string | ||
values | string [] | |||
WebhookPayload | queryParams | WebhookParam [] | ||
httpMethod | string | |||
payload | string |
Jira Agile Types
Name | Routine Usage | Field | Type |
---|---|---|---|
JBoard | id | integer | |
name | string | ||
type | string | ||
JEpic | id | integer | |
name | string | ||
summary | string | ||
done | boolean | ||
JSprint | id | integer | |
name | string | ||
startDate | date | ||
endDate | date | ||
completeDate | date | ||
goal | string | ||
state | string | ||
boardId | integer |
Jira Service Management Types
For actual examples using the structures see the main Jira Service Management routines page or see the individual routine pages.
Name | Routine Usage | Field | Type | |
---|---|---|---|---|
JSlaCompletedCycle | startTime | date | ||
stopTime | date | |||
breached | boolean | |||
goalDuration | number | |||
elepsedTime | number | |||
remainingTime | number | |||
JSlaInformation | name | string | ||
completedCycles | JSlaCompletedCycle | |||
ongoingCycle | JSlaOngoingCycle | |||
JSlaOngoingCycle | startTime | date | ||
breachedTime | date | |||
breached | boolean | |||
paused | boolean | |||
withinCalendarHours | boolean | |||
goalDuration | number | |||
elepsedTime | number | |||
remainingTime | number | |||
JSMApproval
| approvers | JSMApprover [] | ||
canAnswerApproval | boolean | |||
completedDate | date | |||
createdDate | date | |||
finalDecision | string | |||
id | integer | |||
name | string | |||
JSMApprover
| approver | JUser | ||
approverDecision | string | |||
JSMAssetsObject | (used with asset custom fields) | workspaceId | string | |
globalId | string | |||
id | string | |||
JSMAttachment | created | string | ||
filename | string | |||
mimeType | string | |||
size | string | |||
JSMComment
| attachments | JSMAttachment [] | ||
author | JUser | |||
body | string | |||
created | string | |||
id | integer | |||
isPublic | boolean | |||
renderedBody | string | |||
JSMCustomerRequest
| actions | JSMCustomerRequestActions | ||
attachments | string [] | |||
comments | number [] | |||
createdDate | date | |||
currentStatus | JSMCustomerRequestStatus | |||
issueId | integer | |||
issueKey | string | |||
participants | JUser [] | |||
reporter | JUser | |||
requestTypeId | integer | |||
serviceDeskId | integer | |||
slaIds | number [] | |||
status | JSMCustomerRequestStatus [] | |||
JSMCustomerRequestActions
| addAttachment | boolean | ||
addComment | boolean | |||
addParticipant | boolean | |||
removeParticipant | boolean | |||
JSMCustomerRequestStatus
| status | string | ||
statusCategory | string | |||
statusDate | date | |||
JSMFeedback | rating | number | ||
comment | string | |||
type | string | |||
JSMKBArticle | content | string | ||
excerpt | string | |||
source | string | |||
title | string | |||
JSMQueue
| fields | string [] | ||
id | integer | |||
issueCount | integer | |||
jql | string | |||
name | string | |||
JSMRequestType
| description | string | ||
helpText | string | |||
iconId | integer | |||
id | integer | |||
issueTypeId | integer | |||
portalId | integer | |||
name | string | |||
JSMServiceDesk
| id | integer | ||
projectId | integer | |||
projectKey | string | |||
projectName | string |