You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

web/json/app/(:appId)/(~:appVersion)/plugin/(*:pluginName)/service

URL

web/json/app/(:appId)/(~:appVersion)/plugin/(*:pluginName)/service

Method

GET/POST

Description

This plugin serves as the generic access point to any plugin that implements PluginWebSupport in the context of a specific App and App version.

It will call the webService method in the specificied plugin. Thus, the number of parameters needed essentially depends on the plugin itself.

Parameters

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)

Sample Call

http://localhost:8080/jw/web/json/app/leaveApp/2/plugin/org.joget.apps.userview.lib.InboxMenu/service?action=getProcesses

Sample Resul

[
   {
      "value":"",
      "label":""
   },
   {
      "value":"leaveProcess",
      "label":"Leave Process (leaveProcess)"
   }
]

web/json/plugin/(*:pluginName)/service

URL

web/json/plugin/(*:pluginName)/service

Method

GET/POST

Description

This plugin serves as the generic access point to any plugin that implements PluginWebSupport without being in the context of a specific App and App version.

It will call the webService method in the specificied plugin. Thus, the number of parameters needed essentially depends on the plugin itself.

Parameters

Name

Mandatory

Description

pluginName

Yes

Plugin Class Path (E.g. plugin/org.joget.apps.userview.lib.InboxMenu)

Sample Call

http://localhost:8080/jw/web/json/plugin/org.joget.apps.userview.lib.UserPermission/service?action=getUsers

Sample Result

[  
   {  
      "value":"admin",
      "label":"Admin Admin(admin)"
   },
   {  
      "value":"cat",
      "label":"Cat Grant(cat)"
   },
   {  
      "value":"clark",
      "label":"Clark Kent(clark)"
   },
   {  
      "value":"david",
      "label":"David Cain(david)"
   }
]

web/json/hash/options

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

Sample Call

http://localhost:8080/jw/web/json/hash/options

Sample Result

[
   "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"
]

web/json/console/app/(*:appId)/(~:version)/datalist/options

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 column
Default: name

desc

 

Decending
true / false

start

 

Start row count
Integer

rows

 

Return row count
Integer

Sample Call

http://localhost:8080/jw/web/json/console/app/leaveApp/2/datalist/options

Sample Result

[
   {
      "value":"",
      "label":""
   },
   {
      "value":"applicationList",
      "label":"Application List"
   },
   {
      "value":"contactList",
      "label":"Contact List"
   },
   {
      "value":"userApplicationList",
      "label":"User Application List"
   }
]

web/json/console/app/(*:appId)/(~:version)/forms/options

URL

web/json/console/app/(*:appId)/(~:version)/forms/options

Method

GET

Description

List all Forms 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 column
Default: name

desc

 

Decending
true / false

start

 

Start row count
Integer

rows

 

Return row count
Integer

Sample Call

http://localhost:8080/jw/web/json/console/app/leaveApp/2/forms/options

Sample Result

[
   {
      "value":"",
      "label":""
   },
   {
      "value":"submitLeaveForm",
      "label":"1-Submit Leave Form"
   },
   {
      "value":"approveLeaveForm",
      "label":"2-Approve Leave Form"
   },
   {
      "value":"leaveApprovedForm",
      "label":"3-Leave Approved Form"
   }
]

web/json/console/app/(*:appId)/(~:version)/userview/options

URL

web/json/console/app/(*:appId)/(~:version)/userview/options

Method

GET

Description

List all Userviews in of a specific App and App version

Available in Joget version 5

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 column
Default: name

desc

 

Decending
true / false

start

 

Start row count
Integer

rows

 

Return row count
Integer

Sample Call

http://localhost:8080/jw/web/json/console/app/leaveApp/2/userview/options

Sample Result

web/property/json/getElements

URL

Method

Description

Parameters

Name

Mandatory

Description

className

 

 

Sample Call

Sample Result

web/property/json/getPropertyOptions

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

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

Sample Result

  • No labels