Joget DX 8 Stable Released
The stable release for Joget DX 8 is now available, with a focus on UX and Governance.
...
Name | Mandatory | Description |
---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
appVersion | Yes | Application Version (e.g. 2) |
pluginName | Yes | Plugin Class Path (E.g. plugin/org.joget.apps.userview.lib.InboxMenu) |
...
Name | Mandatory | Description |
---|---|---|
pluginName | Yes | Plugin Class Path (E.g. plugin/org.joget.apps.userview.lib.InboxMenu) |
Sample Call
Sample Result
Code Block |
---|
[ { "value":"admin", "label":"Admin Admin(admin)" }, { "value":"cat", "label":"Cat Grant(cat)" }, { "value":"clark", "label":"Clark Kent(clark)" }, { "value":"david", "label":"David Cain(david)" } ] |
URL
web/json/hash/options
Method
GET
Description
This is the utility call used to list down all hash variables' availableSyntax for autocomplete purpose.
Parameters
Name | Mandatory | Description | className |
| |
---|---|---|---|---|---|
start |
|
| |||
rows |
|
|
Sample Call
http://localhost:8080/jw/web/json/hash/options
Sample Result
Code Block |
---|
[
"assignment.activityDefId",
"assignment.activityId",
"assignment.activityName",
"assignment.assigneeId",
"assignment.processDefId",
"assignment.processId",
"assignment.processName",
"assignment.processRequesterId",
"assignment.processVersion",
"currentUser.active",
"currentUser.department.description",
"currentUser.department.id",
"currentUser.department.name",
"currentUser.email",
"currentUser.employee.code",
"currentUser.employee.isHod",
"currentUser.employee.jobTitle",
"currentUser.firstName",
"currentUser.grade.description",
"currentUser.grade.id",
"currentUser.grade.name",
"currentUser.groups.id",
"currentUser.groups.name",
"currentUser.hod.active",
"currentUser.hod.email",
"currentUser.hod.firstName",
"currentUser.hod.lastName",
"currentUser.hod.timeZone",
"currentUser.hod.username",
"currentUser.lastName",
"currentUser.organization.description",
"currentUser.organization.id",
"currentUser.organization.name",
"currentUser.timeZone",
"currentUser.username",
"date.DAY+INTEGER.FORMAT",
"date.DAY-INTEGER.FORMAT",
"date.FORMAT",
"date.MONTH+INTEGER.FORMAT",
"date.MONTH-INTEGER.FORMAT",
"date.YEAR+INTEGER.FORMAT",
"date.YEAR-INTEGER.FORMAT",
"envVariable.KEY",
"form.TABLE.COLUMN",
"form.TABLE.COLUMN[PRIMARY_KEY]",
"i18n.KEY",
"performer.ACTIVITY_DEF_ID.active",
"performer.ACTIVITY_DEF_ID.email",
"performer.ACTIVITY_DEF_ID.firstName",
"performer.ACTIVITY_DEF_ID.id",
"performer.ACTIVITY_DEF_ID.lastName",
"performer.ACTIVITY_DEF_ID.timeZone",
"performer.ACTIVITY_DEF_ID.username",
"requestParam.KEY",
"user.USERNAME.active",
"user.USERNAME.department.description",
"user.USERNAME.department.id",
"user.USERNAME.department.name",
"user.USERNAME.email",
"user.USERNAME.employee.code",
"user.USERNAME.employee.isHod",
"user.USERNAME.employee.jobTitle",
"user.USERNAME.firstName",
"user.USERNAME.grade.description",
"user.USERNAME.grade.id",
"user.USERNAME.grade.name",
"user.USERNAME.groups.id",
"user.USERNAME.groups.name",
"user.USERNAME.hod.active",
"user.USERNAME.hod.email",
"user.USERNAME.hod.firstName",
"user.USERNAME.hod.lastName",
"user.USERNAME.hod.timeZone",
"user.USERNAME.hod.username",
"user.USERNAME.lastName",
"user.USERNAME.organization.description",
"user.USERNAME.organization.id",
"user.USERNAME.organization.name",
"user.USERNAME.timeZone",
"user.USERNAME.username",
"variable.KEY"
] |
URL
web/json/console/app/(*:appId)/(~:version)/datalist/options
Method
GET
Description
List all Datalists in of a specific App and App version
Parameters
Name | Mandatory | Description | ||
---|---|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) | ||
version | Yes |
| Application Version (e.g. 2) | |
callback |
|
| Javascript callback function name | |
sort |
| sort |
| Sort column |
desc |
| Decending | ||
start |
| Start row count | ||
rows |
| Return row count |
Sample Call
http://localhost:8080/jw/web/json/console/app/leaveApp/2/datalist/options
...
URL
web/json/console/app/(*:appId)/(~:version)/forms/options
Method
GET
Description
List all forms Forms in of a specific App and App version
...
Name | Mandatory | Description | ||
---|---|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) | ||
version | Yes | Application Version (e.g. 2) | ||
callback |
|
| Javascript callback function name | |
sort |
| sort |
| Sort column |
desc |
| Decending | ||
start |
| Start row count | ||
rows |
| Return row count |
Sample Call
http://localhost:8080/jw/web/json/console/app/leaveApp/2/forms/options
...
URL
web/json/console/app/(*:appId)/(~:version)/userview/options
Method
GET
Description
List all Userviews in of a specific App and App version
Info |
---|
Available in Joget version 5 |
...
Name | Mandatory | Description | ||
---|---|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) | ||
version | Yes | Application Version (e.g. 2) | ||
callback |
|
| Javascript callback function name | |
sort |
| sort |
| Sort column |
desc |
| Decending | ||
start |
| Start row count | ||
rows |
| Return row count |
Sample Call
http://localhost:8080/jw/web/json/console/app/leaveApp/2/userview/options
...
URL
web/property/json/getElements
Method
GET
Description
Return a list of plugins of the given type.
Parameters
Name | Mandatory | Description | |
---|---|---|---|
className |
| Yes | Plugin Class Path (E.g. org.joget.apps.userview.model.UserviewPermission) |
Sample Call
Sample Result
Code Block |
---|
[
{
"value":"",
"label":""
},
{
"value":"org.joget.plugin.enterprise.AdminUserviewPermission",
"label":"Is Admin"
},
{
"value":"org.joget.plugin.enterprise.AnonymousUserviewPermission",
"label":"Is Anonymous"
},
{
"value":"org.joget.apps.userview.lib.BeanShellPermission",
"label":"Bean Shell Script"
},
{
"value":"org.joget.apps.userview.lib.DepartmentPermission",
"label":"Department"
},
{
"value":"org.joget.apps.userview.lib.GroupPermission",
"label":"Group"
},
{
"value":"org.joget.apps.userview.lib.LoggedInUserPermission",
"label":"Logged In User"
},
{
"value":"org.joget.apps.userview.lib.OrganizationPermission",
"label":"Organization"
},
{
"value":"org.joget.plugin.enterprise.SubLevelUserviewPermission",
"label":"Is Sub Level Userview"
},
{
"value":"org.joget.apps.userview.lib.UserPermission",
"label":"User"
}
] |
URL
web/property/json/getPropertyOptions
Method
GET
Description
Calls the getPropertyOptions() method of the given plugin. This is used primarily in the property editor of Joget to dynamically construct the properties.
Parameters
Name | Mandatory | Description | |
---|---|---|---|
value |
| Yes | Plugin class path (e.g.org.joget.apps.userview.lib.UserPermission) |
Sample Call
Sample Result
Code Block |
---|
[
{
title:'Configure Userview Permission (User)',
properties:[
{
name:'orgId',
label:'Select Organization',
type:'selectbox',
options_ajax:'[CONTEXT_PATH]/web/json/plugin/org.joget.apps.userview.lib.UserPermission/service?action=getOrgs'
},
{
name:'allowedUsernames',
label:'Select Users',
type:'multiselect',
size:'10',
options_ajax_on_change:'orgId',
options_ajax:'[CONTEXT_PATH]/web/json/plugin/org.joget.apps.userview.lib.UserPermission/service?action=getUsers'
}
]
}
] |
URL
Method
Description
Calls the getPropertyOptions() method of the given plugin in a App context. This is used primarily in the property editor of Joget to dynamically construct the properties.
Parameters
Name | Mandatory | Description |
---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version |
| Application Version (e.g. 2) |
value |
|
|
callback |
|
|
Sample Call
Yes | Plugin class path (e.g.org.joget.apps.userview.lib.UserPermission) |
Sample Call
Sample Result
Code Block |
---|
[
{
title:'Configure Validator',
properties:[
{
name:'mandatory',
label:'Mandatory',
type:'checkbox',
value:'true',
options:[
{
value:'true',
label:''
}
]
},
{
name:'type',
label:'Type',
type:'selectbox',
options:[
{
label:'',
value:''
},
{
label:'Alphabet',
value:'alphabet'
},
{
label:'Alphanumeric',
value:'alphanumeric'
},
{
label:'Numeric',
value:'numeric'
},
{
label:'Email',
value:'email'
},
{
label:'Custom Regular Expression',
value:'custom'
}
]
},
{
name:'custom-regex',
label:'Custom Regular Expression',
type:'textfield'
},
{
name:'message',
label:'Custom Error Message Shown When Validation Fail ',
type:'textfield'
}
]
}
] |
...
URL
web/property/json/(*:appId)/(~:version)/getDefaultProperties
Method
GET
Description
To get plugin default properties of a given class path in a App context.
Info |
---|
Available in Joget version 5 |
...
Name | Mandatory | Description |
---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version |
| Application Version (e.g. 2) |
value |
|
|
callback |
|
|
Sample Call
Yes | Plugin class path (e.g.org.joget.apps.userview.lib.UserPermission) |
Sample Call
Sample Result
Code Block |
---|
{
"host":"smtp.gmail.com",
"port":"465",
"security":"",
"username":"",
"password":"****SECURE_VALUE****-0",
"from":"test@test.com",
"toSpecific":"",
"toParticipantId":"",
"cc":"",
"bcc":"",
"subject":"",
"message":"",
"isHtml":"",
"formDefId":"",
"fields":[
],
"files":[
]
} |
...