Page History

App

web/json/app/(*:appId)/(~:version)/form/(*:formId)/columns

Description

Retrieves all columns for a form

User Role

Admin

Method

HTTP GET/POST

Parameters

• • appId - App definition id

    Thai
    appId - รหัสนิยามแอป

  • version - (Optional) App definition version

    Thai
    เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป

  • formId - Form definition Id 

    Thai
    formId - รหัสคำจำกัดความของแบบฟอร์ม

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

Description

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

    Thai
    callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้

  • plugin - Class name of generator plugin to execute

    Thai
    appId - รหัสนิยามแอป

  • appId - App Definition id

    Thai
    พารามิเตอร์

  • version - (Optional) App definition version

    Thai
    เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป

  • formId - Form defintion id

    Thai
    formId - 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

Description

Downloads and imports an app form an URL

User Role

Admin

  Method

HTTP POST

  Parameters

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method

    Thai
    callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้

  • url - Url to download an app

    Thai
    url - Url เพื่อดาวน์โหลดแอป

    
    

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

Description

Retrieves all published processes based on logged in user

User RoleRole

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

• • callback - (Optional) a function (in JavaScript) to call back after invoking this method

    Thai
    callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อเรียกกลับหลังจากเรียกใช้วิธีนี้

  • appId - (Optional) App definition Id to filter the list

    Thai
    appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

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

Description

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

    Thai
    callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อเรียกกลับหลังจากเรียกใช้วิธีนี้

  • appId - (Optional) App definition Id to filter the list

    Thai
    appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

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

Description

Retrieves all apps

User Role

...

• • 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  

Description

Retrieves all version of an app

...

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

Description

Retrieves all Datalist Actions plugins

...

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

Description

Retrieves all environment variable of an app

...

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

Description

Retrieves all datalist of an app

...

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

Description

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

...

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

Description

Retrieves all table name used in an app

...

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

Description

Retrieves all forms in an app

...

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

Description

Retrieves all form in an app in value-label pair 

...

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

Description

Deploy a new version of XPDL to an app

...

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

Description

Retrieves XPDL file of an app

...

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

Description

Retrieves all configured default plugin properties of an app

...

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

Description

Retrieves all created custom i18n message of an app

...

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

Description

Retrieves all userviews of an app

...

Sample URL
http:/localhost:8080/jw/web/json/workflow/process/list/package

Sample Result

...

{
    "data": [{
        "id": "hr_expense",
        "count": 2,
        "processVersion": "3",
        "packageName": "HR Expenses Claim App",
        "processId": "hr_expense#3#process1",
        "processName": "Expense Approval Process",
        "packageId": "hr_expense",
        "label": "HR Expenses Claim App",
        "url": "/json/workflow/process/list?packageId=hr_expense"
    }, {
        "id": "isr",
        "count": 1,
        "processVersion": "2",
        "packageName": "ISR",
        "processId": "isr#2#isr",
        "processName": "ISR Process",
        "packageId": "isr",
        "label": "ISR",
        "url": "/json/workflow/process/list?packageId=isr"
    }, {
        "id": "hrleave",
        "count": 2,
        "processVersion": "1",
        "packageName": "JINC Leave Solution",
        "processId": "hrleave#1#la",
        "processName": "Leave Application System",
        "packageId": "hrleave",
        "label": "JINC Leave Solution",
        "url": "/json/workflow/process/list?packageId=hrleave"
    }]
}

{"activityId":"885_224_crm_process1_approve_proposal","processId":"224_crm_process1"}

{"status" : "variableSet"}

{
    "packageName": "CRM",
    "processId": "crm#3#process1",
    "name": "Proposal Approval Process",
    "packageId": "crm",
    "version": "3"
}

{
    "processId": "208_crm_process1",
    "variable": {
        "status": "approved"
    }
}

Monitoring

web/json/monitoring/activity/abort/(*:processId)/(*:activityDefId)

...

http://localhost:8080/jw/web/json/monitoring/activity/reevaluate?activityId=841_206_crm_process1_send_proposal 

web/json/monitoring/activity/start/(*:processId)/(*:activityDefId)

...