...
Name | Mandatory | Description |
|---|---|---|
appId | Yes | Application ID (e.g. leaveApp) |
appVersion | Yes | Application Version (e.g. 2) |
pluginName | Yes | Plugin Class Path (E.g. 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 |
...
Name | Mandatory | Description |
|---|---|---|
className | Yes | Plugin Class Path (E.g. org.joget.apps.userview.model.UserviewPermission) |
Sample Call
Sample Result
...
web/property/json/getPropertyOptions
URLMethod
Description
Parameters
Name | Mandatory | Description |
|---|---|---|
value |
|
|
Sample Call
Sample Result
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.
URL
Method
Description
Parameters
Name | Mandatory | Description | |
|---|---|---|---|
appId value |
| Yes | Plugin class path Application ID (e.g. leaveApporg.joget.apps.userview.lib.UserPermission) |
version |
| Application Version (e.g. 2) | |
value |
|
| |
callback |
|
|
Sample Call
Sample Result
Sample Call
http://localhost:8080/jw/web/property/json/
...
getPropertyOptions?value=org.joget.apps.userview.lib.UserPermission
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
| 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
...