Plugin

This page details the Plugin endpoints and the actions they support. It provides sample URLs and results for quick reference, along with further instructions on how to use each endpoint.

web/json/plugin/list

Retrieves a list of plugins.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • className - (Optional) class name of plugin type abstract class or interface 
  • start - where rows start from
  • rows - number of rows per page
• Sample URL: 
• http://localhost:8080/jw/web/json/plugin/list?start=0&rows=5
• Sample Result: 

{
    "total": 140,
    "start": 0,
    "data": [{
        "id": "org.joget.plugin.enterprise.AjaxSubForm",
        "description": "AJAX Subform Element",
        "name": "AJAX Subform",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdminUserviewPermission",
        "description": "",
        "name": "Is Admin",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdvancedFormRowDataListBinder",
        "description": "Retrieves data rows from a form table.",
        "name": "Advanced Form Data Binder",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AdvancedGrid",
        "description": "Advanced Grid Element",
        "name": "Advanced Grid",
        "version": "5.0.0"
    }, {
        "id": "org.joget.plugin.enterprise.AnonymousUserviewPermission",
        "description": "",
        "name": "Is Anonymous",
        "version": "5.0.0"
    }]
}

web/json/plugin/listOsgi

Retrieves a list of OSGI plugins.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • className - (Optional) class name of plugin type abstract class or interface 
  • start - where rows start from
  • rows - number of rows per page
• Sample URL: http://localhost:8080/jw/web/json/plugin/listOsgi?start=0&rows=10
• Sample Result: 

{
    "total": 1,
    "start": 0,
    "data": {
        "id": "test.directory.TestDirectoryManager",
        "description": "Test Directory Manager",
        "name": "Test Directory Manager",
        "version": "1.0.0"
    }
}

web/property/json/getElements

Retrieves options of plugins based on a plugin type abstract class or interface.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • classname - class name of plugin type abstract class or interface 
• Sample URL: http://localhost:8080/jw/web/property/json/getElements?classname=org.joget.plugin.base.DefaultApplicationPlugin
• Sample Result:

[{
    "value": "",
    "label": ""
}, {
    "value": "org.joget.apps.app.lib.DatabaseUpdateTool",
    "label": "Database Update Tool"
}, {
    "value": "org.joget.apps.app.lib.EmailTool",
    "label": "Email Tool"
}, {
    "value": "org.joget.apps.app.lib.JsonTool",
    "label": "Json Tool"
}]

web/property/json/getPropertyOptions

Retrieves the Plugin Properties Options of a plugin.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • value - Plugin class name
• Sample URL: http://localhost:8080/jw/web/property/json/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool
• Sample Result: 

[{
    title: 'Configure Bean Shell',
    properties: [{
        name: 'script',
        label: 'Script',
        type: 'codeeditor',
        required: 'True',
        mode: 'java'
    }]
}]

web/property/json/(*:appId)/(~:version)/getDefaultProperties

Retrieves the default Plugin Properties Options of a plugin based on App Definition meta.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • appId - App Definition Id
  • version - (Optional) App Definition version
  • value - Plugin class name
• Sample URL: http://localhost:8080/jw/web/property/json/crm/getDefaultProperties?value=org.joget.apps.app.lib.EmailTool
• Sample Result:

{
    "host": "smtp.gmail.com",
    "port": "456",
    "security": "SSL",
    "username": "test@gmail.com",
    "password": "test",
    "from": "test@gmail.com",
    "toSpecific": "",
    "toParticipantId": "",
    "cc": "",
    "bcc": "",
    "subject": "",
    "message": "",
    "isHtml": "",
    "formDefId": "",
    "fields": [],
    "files": []
}

web/property/json/(*:appId)/(~:version)/getPropertyOptions

Retrieves the Plugin Properties Options of a plugin with App Definition meta.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • appId - App Definition Id
  • version - (Optional) App Definition version
  • value - Plugin class name
• Sample URL: http://localhost:8080/jw/web/property/json/crm/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool
• Sample Result: 

[{
    title: 'Configure Bean Shell',
    properties: [{
        name: 'script',
        label: 'Script',
        type: 'codeeditor',
        required: 'True',
        mode: 'java'
    }]
}]