...
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 |
|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version | Yes | Application Version (e.g. 2) |
callback |
| Javascript callback function name |
sort |
| Sort column |
desc |
| Decending |
start |
| Start row count |
rows |
| Return row count |
...
Name | Mandatory | Description |
|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version | Yes | Application Version (e.g. 2) |
callback |
| Javascript callback function name |
sort |
| Sort column |
desc |
| Decending |
start |
| Start row count |
rows |
| Return row count |
...
Name | Mandatory | Description |
|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version | Yes | Application Version (e.g. 2) |
callback |
| Javascript callback function name |
sort |
| Sort column |
desc |
| Decending |
start |
| Start row count |
rows |
| Return row count |
...
web/property/json/getElements
URL
web/property/json/getElements
Method
GET
Description
Return a list of plugins of the given type.
Parameters
Name | Mandatory | Description |
|---|---|---|
className |
|
|
Sample Call
Sample Result
Yes | Plugin Class Path (E.g. org.joget.apps.userview.model.UserviewPermission) |
Sample Call
http://localhost:8080/jw/web/property/json/
...
getElements?classname=org.joget.apps.userview.model.UserviewPermission
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"
}
] |
web/property/json/getPropertyOptions
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'
}
]
}
] |
web/property/json/(*:appId)/(~:version)/getPropertyOptions
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 | 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'
}
]
}
] |
web/property/json/(*:appId)/(~:version)/getDefaultProperties
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 |
Parameters
Name | Mandatory | Description |
|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
version |
| Application Version (e.g. 2) |
value | 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":[
]
} |
URL
Method
Description
Parameters
Name | Mandatory | Description |
|---|---|---|
value |
|
|
Sample Call
Sample Result
web/property/json/(*:appId)/(~:version)/getPropertyOptions
URL
Method
Description
Parameters
Name | Mandatory | Description |
|---|---|---|
appId |
| Application ID (e.g. leaveApp) |
version |
| Application Version (e.g. 2) |
value |
|
|
callback |
|
|
Sample Call
Sample Result
web/property/json/(*:appId)/(~:version)/getDefaultProperties
URL
Method
Description
| Info |
|---|
Available in Joget version 5 |
Parameters
Name | Mandatory | Description |
|---|---|---|
appId |
| Application ID (e.g. leaveApp) |
version |
| Application Version (e.g. 2) |
value |
|
|
callback |
|
|
Sample Call
...