Knowledge Base
  • Select Role
  • English
  • Login

App

This page details the App 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/app/(*:appId)/(~:version)/form/(*:formId)/columns

Retrieves all columns for a form.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • appId - App definition id
    • version - (Optional) App definition version
    • formId - Form definition Id
  • Sample URL: http://localhost:8080/jw/web/json/app/crm/form/crm_account/columns
  • Sample Result:
[{
    "value": "accountName",
    "label": "Account Name"
}, {
    "value": "address",
    "label": "address"
}, {
    "value": "city",
    "label": "City"
}, {
    "value": "country",
    "label": "Country"
}, {
    "value": "dateCreated",
    "label": "Date Created"
}, {
    "value": "dateModified",
    "label": "Date Modified"
}, {
    "value": "id",
    "label": "ID"
}, {
    "value": "state",
    "label": "State"
}]

 

web/json/app/(*:appId)/(~:version)/generator/(*:formId)/generate

Executes a generator plugin based on a form.

  • User Role: Admin
  • Method: HTTP POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • plugin - Class name of generator plugin to execute
    • appId - App Definition id
    • version - (Optional) App definition version
    • formId - Form definition id
  • Sample URL: http://localhost:8080/jw/web/json/app/crm/generator/crm_account/generate?plugin=org.joget.plugin.enterprise.CrudGenerator
  • Sample Result:
{
    "message": "CRUD generated. Click <a href=\"/jw/web/console/app/crm/2/userview/builder/crm_userview_sales?menuId=c4a0c79c-c0a83810-5291318b-96650e7d\" target=\"_blank\">here<\/a> to continue edit CRUD in Userview Builder.",
    "error": false,
    "pluginDisabled": false
}

 

web/json/apps/install

Downloads and imports an app from an URL

  • User Role: Admin
  • Method: HTTP POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • url - Url to download an app
  • Sample URL: http://localhost:8080/jw/web/json/apps/install?url= http%3A%2F%2Fwww.joget.org%2Fdownloads%2Fsimple_crm.jwa
  • Sample Result:
{
    "appId" : "mcrm",
    "appName" : "Simple CRM",
    "appVersion: : "1"
}

 

web/json/apps/published/processes

Retrieves all published processes based on logged in user.

  • User Role: Anyone (Including anonymous)
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - (Optional) App definition Id to filter the list
  • Sample URL: http://localhost:8080/jw/web/json/apps/published/processes?appId=crm
  • Sample Result: 
{
    "apps": [{
        "processes": [{
            "id": "crm#3#process1",
            "processVersion": "3",
            "appVersion": 2,
            "name": "Proposal Approval Process",
            "idWithoutVersion": "process1",
            "url": "/jw/web/client/app/crm/2/process/process1?start=true"
        }],
        "id": "crm",
        "name": "CRM",
        "version": 2
    }]
}

 

web/json/apps/published/userviews

Retrieves all published userviews based on logged in user.

  • User Role: Anyone (Including anonymous)
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - (Optional) App definition Id to filter the list
  • Sample URL: http://localhost:8080/jw/web/json/apps/published/userviews?appId=crm
  • Sample Result:
{
    "apps": [{
        "id": "crm",
        "name": "CRM",
        "userviews": [{
            "id": "crm_userview_sales",
            "description": "",
            "name": "CRM: Sales Force Automation",
            "url": "/jw/web/userview/crm/crm_userview_sales",
            "version": 2
        }],
        "version": 2
    }]
}

 

web/json/console/app/list

Retrieves all apps.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • name - (Optional) name filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/list?name=crm
  • Sample Result:
{
    "total": 2,
    "data": [{
        "id": "crm",
        "name": "CRM",
        "version": 2
    }, {
        "id": "mcrm",
        "name": "Simple CRM",
        "version": 1
    }]
}

 

web/json/console/app/(*:appId)/version/list  

Retrieves all versions of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http:/localhost/jw/web/json/workflow/process/list/package
  • Sample Result:
{
    "total": 2,
    "data": [{
        "dateModified": "23-07-2015 07:25 AM",
        "description": null,
        "dateCreated": "28-05-2015 10:08 PM",
        "published": "",
        "version": "1"
    }, {
        "dateModified": "04-09-2015 03:05 AM",
        "description": null,
        "dateCreated": "22-07-2015 11:24 PM",
        "published": "<div class=\"tick\"><\/div>",
        "version": "2"
    }]
}

 

web/json/console/app/(*:appId)/(~:version)/builder/actions  

Retrieves all Datalist Actions plugins.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • appID - App Definition Id
    • version - (Optional) App Definition version
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/builder/actions
  • Sample Result:
{
    "actions": [{
        "name": "Data List Hyperlink Action",
        "className": "org.joget.apps.datalist.lib.HyperlinkDataListAction",
        "label": "Hyperlink",
        "type": "text",
        "propertyOptions": "[{     title : 'Configure Link',     properties : [{         label : 'Hyperlink',         name : 'href',         type : 'textfield',         description : 'URL (Eg. http:\\/\\/www.google.com)'     },     {         label : 'Hyperlink Target',         name : 'target',         type : 'selectbox',         description : 'Hyperlink Target is for Row Action usage only',         options : [{             value : '_self',             label : 'Current Window'         },         {             value : '_blank',             label : 'New Window'         },         {             value : 'popup',             label : 'Popup Dialog'         }]     },     {         name : 'parameters',         label : 'Hyperlink Parameters',         type : 'gridCombine',         columns : [{             key : 'hrefParam',             label : 'Parameter Name'         },         {             key : 'hrefColumn',             label : 'Column Name'         }]     },     {         label : 'Label',         name : 'label',         type : 'textfield',         description : 'Label shown in the column (for row actions)',         value : 'Hyperlink'     },     {         label : 'Confirmation Message',         name : 'confirmation',         type : 'textfield'     },     {         label : 'Visible when no record or checkbox? ',         name : 'visible',         type : 'checkbox',         options : [             {'value' : 'true', 'label' : ''}         ]     }] }]"
    }, {
        "name": "Form Row Delete Action",
        "className": "org.joget.apps.datalist.lib.FormRowDeleteDataListAction",
        "label": "Delete",
        "type": "text",
        "propertyOptions": "[{     title : 'Edit Delete Action',     properties : [{         name : 'label',         label : 'Label',         type : 'textfield'     },     {name:'formDefId',label:'Form',type:'selectbox',options_ajax:'[CONTEXT_PATH]/web/json/console/app/crm/2/forms/options',required:'True'},{         name : 'confirmation',         label : 'Confirmation Message',         type : 'textfield'     },     {         name:'deleteGridData',         label:'Delete Associated Grid Data?',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     },     {         name:'deleteSubformData',         label:'Delete Associated Child Form Data? ',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     },     {         name:'abortRelatedRunningProcesses',         label:'Abort Related Running Processes? ',         type:'checkbox',         value:'false',         options:[             {                 value:'true',                 label:''             }         ]     }] }]"
    }]
}

 

web/json/console/app/(*:appId)/(~:version)/envVariable/list

Retrieves all environment variables of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version- (Optional) App Definiton version
    • filter - (Optional) id filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/envVariable/list
  • Sample Result:
{
    "total": 2,
    "data": [{
        "id": "refNo",
        "value": "75",
        "remarks": "Used for plugin: IdGeneratorField"
    }, {
        "id": "welcome",
        "value": "<b>Welcome Message<\/b>",
        "remarks": ""
    }]
}

 

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

Retrieves all datalist of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/datalist/list
  • Sample Result:
{
    "total": 3,
    "data": [{
        "id": "crm_contact_list",
        "dateModified": "22-07-2015 11:24 PM",
        "description": "Contact List",
        "name": "Contact List",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_inbox",
        "dateModified": "28-08-2015 09:42 AM",
        "description": null,
        "name": "Task Inbox",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_opportunity_list",
        "dateModified": "22-07-2015 11:24 PM",
        "description": "Opportunity List",
        "name": "Opportunity List",
        "dateCreated": "22-07-2015 11:24 PM"
    }]
}

 

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

Retrieves all datalist of an app in value-label pair.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version - (optional) App Definition version
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/datalist/options
  • Sample Result:
[{
    "value": "",
    "label": ""
}, {
    "value": "crm_account_list",
    "label": "Account Listing"
}, {
    "value": "crm_contact_list",
    "label": "Contact List"
}, {
    "value": "crm_opportunity_list",
    "label": "Opportunity List"
}, {
    "value": "crm_inbox",
    "label": "Task Inbox"
}]

 

web/json/console/app/(*:appId)/(~:version)/form/tableNameList

Retrieves all table names used in an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition Id
    • version - (Optional) App Definition version
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/form/tableNameList
  • Sample Result:
{
    "tableName": ["crm_account", "crm_contact", "crm_opportunity", "crm_proposal"]
}

 

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

Retrieves all forms in an app

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • name - (Optional) name filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/forms
  • Sample Result:
{
    "total": 7,
    "data": [{
        "id": "crm_account",
        "dateModified": "07-09-2015 08:30 AM",
        "tableName": "crm_account",
        "name": "Account Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_contact",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_contact",
        "name": "Contact Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_opportunity",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_opportunity",
        "name": "Opportunity Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_approval_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Approval Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_form",
        "dateModified": "13-08-2015 02:55 AM",
        "tableName": "crm_proposal",
        "name": "Proposal Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_resubmit_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Resubmit Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }, {
        "id": "crm_proposal_sending_form",
        "dateModified": "22-07-2015 11:24 PM",
        "tableName": "crm_proposal",
        "name": "Proposal Sending Form",
        "dateCreated": "22-07-2015 11:24 PM"
    }]
}

 

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

Retrieves all form in an app in value-label pair.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/forms/options
  • Sample Result:
[{
    "value": "",
    "label": ""
}, {
    "value": "crm_account",
    "label": "Account Form"
}, {
    "value": "crm_contact",
    "label": "Contact Form"
}, {
    "value": "crm_opportunity",
    "label": "Opportunity Form"
}, {
    "value": "crm_proposal_approval_form",
    "label": "Proposal Approval Form"
}, {
    "value": "crm_proposal_form",
    "label": "Proposal Form"
}, {
    "value": "crm_proposal_resubmit_form",
    "label": "Proposal Resubmit Form"
}, {
    "value": "crm_proposal_sending_form",
    "label": "Proposal Sending Form"
}]

 

web/json/console/app/(*:appId)/(~:version)/package/deploy

Deploy a new version of XPDL to an app.

  • User Role: Admin
  • Method: HTTP POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • packageXpdl - Multipart file of a XPDL file
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/package/deploy
  • Sample Result:
{"status" : "complete"}

 

web/json/console/app/(*:appId)/(~:version)/package/xpdl

Retrieves XPDL file of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • appId - App Definition id
    • version - (Optional) App Definition version
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/package/xpdl

 

web/json/console/app/(*:appId)/(~:version)/pluginDefault/list

Retrieves all configured default plugin properties of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/pluginDefault/list
  • Sample Result:
{
    "total": 2,
    "data": [{
        "id": "org.joget.apps.app.lib.EmailTool",
        "pluginName": "Email Tool",
        "pluginDescription": "Sends email message to targeted recipient(s)"
    }, {
        "id": "org.joget.apps.app.lib.ProcessDataCollectorAuditTrail",
        "pluginName": "Process Data Collector",
        "pluginDescription": "Save process data into app_report_* tables for reporting purposes"
    }]
}

 

web/json/console/app/(*:appId)/(~:version)/message/list

Retrieves all created custom i18n messages of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) ID and message filter
    • locale - (Optional) language code for filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/message/list
  • Sample Result:
{
    "total": 1,
    "data": {
        "message": "查询",
        "id": "general.method.label.search_zh_CN",
        "locale": "zh_CN",
        "messageKey": "general.method.label.search"
    }
}

 

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

Retrieves all userviews of an app.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • filter - (Optional) name filter
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/userview/list
  • Sample Result:
{
    "total": 1,
    "data": {
        "id": "crm_userview_sales",
        "dateModified": "13-09-2015 02:55 AM",
        "description": "",
        "name": "CRM: Sales Force Automation",
        "dateCreated": "22-07-2015 11:24 PM"
    }
}

 

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

Retrieves all userviews of an app in value-label pair.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters:
    • callback - (Optional) a function (in JavaScript) to call back after invoking this method
    • appId - App Definition id
    • version - (Optional) App Definition version
    • sort - (Optional) column name to be sorted
    • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
    • start - (Optional) where rows start from
    • rows - (Optional) number of rows per page
  • Sample URL: http://localhost:8080/jw/web/json/console/app/crm/userview/options
  • Sample Result :
[{
    "value": "",
    "label": ""
}, {
    "value": "crm_userview_sales",
    "label": "CRM: Sales Force Automation"
}]

 

web/json/workflow/package/list

Retrieves package (app) list.

  • User Role: Admin
  • Method: HTTP GET/POST
  • Parameters: 
    • callback - a function (in JavaScript) to call back after invoking this method
  • Sample URL: http://localhost:8080/jw/web/json/workflow/package/list
  • Sample Result: 
{
    "data": [{
        "packageId": "crm",
        "packageName": "CRM"
    }, {
        "packageId": "helpdesk",
        "packageName": "Helpdesk"
    }]
}

 

Created by Damian Last modified by Aadrian on Dec 13, 2024
Tags:
Previous JSON API NextAssignments