Page History

The API Domain Whitelist setting in General Settings needs to be configured to allow JSON API requests. If a request is from a non-whitelisted domain, the response will be a HTTP 400 Bad Request.

แอป

ลักษณะ

ดึงคอลัมน์ทั้งหมดสำหรับฟอร์ม

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• formId - รหัสคำจำกัดความของแบบฟอร์ม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/app/crm/form/crm_account/columns

ตัวอย่างผลลัพธ์

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

ลักษณะ

เรียกใช้ปลั๊กอินตัวสร้างโดยยึดตามฟอร์ม

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• plugin - ชื่อคลาสของปลั๊กอินตัวสร้างที่จะดำเนินการ
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• formId - id การกำหนดรูปแบบ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/app/crm/generator/crm_account/generate?plugin=org.joget.plugin.enterprise.CrudGenerator

ตัวอย่างผลลัพธ์

{
    "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
}

ลักษณะ

ดาวน์โหลดและนำเข้าแอปเป็น URL

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/apps/install?url= http%3A%2F%2Fwww.joget.org%2Fdownloads%2Fsimple_crm.jwa

ตัวอย่างผลลัพธ์

{
    "appId" : "mcrm",
    "appName" : "Simple CRM",
    "appVersion: : "1"
}

ลักษณะ

ดึงกระบวนการเผยแพร่ทั้งหมดขึ้นอยู่กับผู้ใช้ที่เข้าสู่ระบบ

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/apps/published/processes?appId=crm

ตัวอย่างผลลัพธ์

{
    "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
    }]
}

ลักษณะ

ดึง userviews ที่เผยแพร่ทั้งหมดขึ้นอยู่กับผู้ใช้ที่เข้าสู่ระบบ

บทบาทของผู้ใช้

ทุกคน (รวมที่ไม่ระบุชื่อ)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/apps/published/userviews?appId=crm

ตัวอย่างผลลัพธ์

{
    "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
    }]
}

ลักษณะ

ดึงแอพทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/list?name=crm

ตัวอย่างผลลัพธ์

{
    "total": 2,
    "data": [{
        "id": "crm",
        "name": "CRM",
        "version": 2
    }, {
        "id": "mcrm",
        "name": "Simple CRM",
        "version": 1
    }]
}

ลักษณะ

ดึงแอปทุกเวอร์ชัน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http:/localhost/jw/web/json/workflow/process/list/package

ตัวอย่างผลลัพธ์

{
    "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"
    }]
}

ลักษณะ

ดึงปลั๊กอินการกระทำของ Datalist ทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/builder/actions

ตัวอย่างผลลัพธ์

{
    "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:''             }         ]     }] }]"
    }]
}

ลักษณะ

ดึงตัวแปรสภาพแวดล้อมทั้งหมดของแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสแอพที่แน่นอน
• version- (เป็นทางเลือก) เวอร์ชัน App ของแอป
• ตัวกรอง - (ตัวเลือก) ตัวกรองรหัส
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/envVariable/list

ตัวอย่างผลลัพธ์

{
    "total": 2,
    "data": [{
        "id": "refNo",
        "value": "75",
        "remarks": "Used for plugin: IdGeneratorField"
    }, {
        "id": "welcome",
        "value": "<b>Welcome Message<\/b>",
        "remarks": ""
    }]
}

ลักษณะ

ดึงข้อมูล datalist ทั้งหมดของแอพ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• ตัวกรอง - (ตัวเลือก) ตัวกรองชื่อ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/datalist/list

ตัวอย่างผลลัพธ์

{
    "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"
    }]
}

ลักษณะ

ดึงข้อมูลทั้งหมดของแอปในคู่ของป้ายกำกับมูลค่า

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสการกำหนดแอป
• เวอร์ชั่น - (เป็นตัวเลือก) เวอร์ชั่นของแอปที่กำหนด
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

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

ตัวอย่างผลลัพธ์

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

ลักษณะ

ดึงชื่อตารางทั้งหมดที่ใช้ในแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชั่นของแอปที่กำหนด

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/form/tableNameList

ตัวอย่างผลลัพธ์

{
    "tableName": ["crm_account", "crm_contact", "crm_opportunity", "crm_proposal"]
}

ลักษณะ

ดึงฟอร์มทั้งหมดในแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/forms

ตัวอย่างผลลัพธ์

{
    "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"
    }]
}

ลักษณะ

ดึงฟอร์มทั้งหมดในแอปใน value-label

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป

ตัวอย่าง URL

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

ตัวอย่างผลลัพธ์

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

ลักษณะ

ปรับใช้ XPDL เวอร์ชันใหม่กับแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• packageXpdl - ไฟล์ Multipart ของไฟล์ XPDL

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/package/deploy

ตัวอย่างผลลัพธ์

{"status" : "complete"}

ลักษณะ

ดึงไฟล์ XPDL ของแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/package/xpdl

ลักษณะ

ดึงคุณสมบัติปลั๊กอินเริ่มต้นที่กำหนดค่าไว้ทั้งหมดของแอพ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• ตัวกรอง - (ตัวเลือก) ตัวกรองชื่อ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/pluginDefault/list

ตัวอย่างผลลัพธ์

{
    "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"
    }]
}

ลักษณะ

ดึงข้อความ i18n ที่กำหนดเองที่สร้างขึ้นทั้งหมดของแอป

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• ตัวกรอง - (ตัวเลือก) id และตัวกรองข้อความ
• locale - รหัสภาษา (เป็นตัวเลือก) สำหรับตัวกรอง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/message/list

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "message": "查询",
        "id": "general.method.label.search_zh_CN",
        "locale": "zh_CN",
        "messageKey": "general.method.label.search"
    }
}

ลักษณะ

ดึงตัวอย่างการใช้งานแอพทั้งหมดของเรา

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• ตัวกรอง - (ตัวเลือก) ตัวกรองชื่อ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/console/app/crm/userview/list

ตัวอย่างผลลัพธ์

{
    "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"
    }
}

ลักษณะ
ดึงตัวอย่างการใช้งานแอพทั้งหมดในคู่ของป้ายกำกับมูลค่า

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - รหัสนิยามแอป
• เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

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

ตัวอย่างผลลัพธ์

[{
    "value": "",
    "label": ""
}, {
    "value": "crm_userview_sales",
    "label": "CRM: Sales Force Automation"
}]

ลักษณะ
ดึงรายการแพคเกจ (แอป)

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/package/list

ตัวอย่างผลลัพธ์

{
    "data": [{
        "packageId": "crm",
        "packageName": "CRM"
    }, {
        "packageId": "helpdesk",
        "packageName": "Helpdesk"
    }]
}

Deprecated  Since v3, the concept of accept & withdraw assignment is removed  

ลักษณะ
ยอมรับการมอบหมายที่ได้รับมอบหมาย

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/accept/879_223_crm_process1_approve_proposal

ตัวอย่างผลลัพธ์

{
    "assignment" : "879_223_crm_process1_approve_proposal"
    "status" : "accepted"
}

ลักษณะ
เสร็จสิ้นภารกิจที่ได้รับมอบหมาย

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/complete/879_223_crm_process1_approve_proposal

ตัวอย่างผลลัพธ์

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "nextActivityId": "882_223_crm_process1_send_proposal",
    "processId": "223_crm_process1",
    "status": "completed"
}

ลักษณะ
เสร็จสิ้นการกำหนดที่ได้รับมอบหมายพร้อมตัวเลือกในการตั้งค่าตัวแปรเวิร์กโฟลว์

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม
• var_ * - (ไม่บังคับ) พารามิเตอร์นำหน้าด้วย "var_" ใช้เพื่อตั้งค่าตัวแปรเวิร์กโฟลว์

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/complete/879_223_crm_process1_approve_proposal ?var_status=Sent

ตัวอย่างผลลัพธ์

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "nextActivityId": "882_223_crm_process1_send_proposal",
    "processId": "223_crm_process1",
    "status": "completed"
}

ลักษณะ
ดึงการมอบหมายทั้งหมดของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• packageId - (ไม่บังคับ) รหัสคำจำกัดความของแอป
• processDefId - (เป็นทางเลือก) ID นิยามกระบวนการที่มีเวอร์ชัน
• processId - (เป็นทางเลือก) id อินสแตนซ์ของกระบวนการ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list?rows=3&packageId=crm

ตัวอย่างผลลัพธ์

{
    "total": 10,
    "data": [{
        "id": "477_118_crm_process1_approve_proposal",
        "activityId": "477_118_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "118_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "479_119_crm_process1_approve_proposal",
        "activityId": "479_119_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "119_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "481_120_crm_process1_approve_proposal",
        "activityId": "481_120_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "120_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }]
}

ลักษณะ
ดึงข้อมูลจำนวนการมอบหมายของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• packageId - (ไม่บังคับ) รหัสคำจำกัดความของแอป
• processDefId - (เป็นทางเลือก) ID นิยามกระบวนการที่มีเวอร์ชัน
• processId - (เป็นทางเลือก) id อินสแตนซ์ของกระบวนการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/count?packageId=crm

ตัวอย่างผลลัพธ์

{"total":10}

Deprecated  Since v3, the concept of accept & withdraw assignment is removed  

ลักษณะ
ดึงการมอบหมายที่ยอมรับทั้งหมดของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - (เป็นทางเลือก) id อินสแตนซ์ของกระบวนการ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted?rows=3

ตัวอย่างผลลัพธ์

{
    "total": 10,
    "data": [{
        "id": "477_118_crm_process1_approve_proposal",
        "activityId": "477_118_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "118_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "479_119_crm_process1_approve_proposal",
        "activityId": "479_119_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "119_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }, {
        "id": "481_120_crm_process1_approve_proposal",
        "activityId": "481_120_crm_process1_approve_proposal",
        "processVersion": "1",
        "serviceLevelMonitor": "-",
        "processId": "120_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "21-07-2015 03:03 AM",
        "label": "Approve Proposal",
        "acceptedStatus": false,
        "activityName": "Approve Proposal"
    }]
}

Deprecated  Since v3, the concept of accept & withdraw assignment is removed  

ลักษณะ
ดึงการมอบหมายที่ยอมรับทั้งหมดของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - (เป็นทางเลือก) id อินสแตนซ์ของกระบวนการ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted/count

ตัวอย่างผลลัพธ์

{"total":3}

Deprecated  Since v3, the concept of accept & withdraw assignment is removed  

ลักษณะ

ดึงรายการกระบวนการขึ้นอยู่กับการกำหนดที่ยอมรับของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/accepted/process

ตัวอย่างผลลัพธ์

{
    "data": [{
        "count": 3,
        "processVersion": "3",
        "processName": "Proposal Approval Process",
        "processDefId": "crm#3#process1",
        "label": "Proposal Approval Process ver 3 (3)",
        "url": "/json/workflow/assignment/list/accepted?processId=crm%233%23process1"
    }]
}

ลักษณะ
ดึงการมอบหมายที่ค้างอยู่ทั้งหมดของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - (เป็นทางเลือก) id อินสแตนซ์ของกระบวนการ
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/pending

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "id": "841_206_crm_process1_send_proposal",
        "activityId": "841_206_crm_process1_send_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "206_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Send Proposal",
        "activityName": "Send Proposal"
    }, {
        "id": "842_207_crm_process1_approve_proposal",
        "activityId": "842_207_crm_process1_approve_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "207_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Approve Proposal",
        "activityName": "Approve Proposal"
    }, {
        "id": "843_208_crm_process1_send_proposal",
        "activityId": "843_208_crm_process1_send_proposal",
        "processVersion": "3",
        "serviceLevelMonitor": "-",
        "processId": "208_crm_process1",
        "description": "",
        "processName": "Proposal Approval Process",
        "due": "-",
        "dateCreated": "04-09-2015 11:05 AM",
        "label": "Send Proposal",
        "activityName": "Send Proposal"
    }]
}

ลักษณะ
ดึงข้อมูลจำนวนของการมอบหมายที่ค้างอยู่ทั้งหมดของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/list/pending/count

ตัวอย่างผลลัพธ์

{"total":3}

ลักษณะ
ดึงรายการกระบวนการตามการมอบหมายที่รอดำเนินการของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http:/localhost:8080/jw/web/json/workflow/assignment/list/pending/process

ตัวอย่างผลลัพธ์

{
    "data": [{
        "count": 3,
        "processVersion": "3",
        "processName": "Proposal Approval Process",
        "processDefId": "crm#3#process1",
        "label": "Proposal Approval Process ver 3 (3)",
        "url": "/json/workflow/assignment/list/accepted?processId=crm%233%23process1"
    }]
}

ลักษณะ
ดึงข้อมูลกระบวนการตามการมอบหมายที่มีอยู่ของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/process/view/208_crm_process1

ตัวอย่างผลลัพธ์

{
    "activityId": "843_208_crm_process1_send_proposal",
    "processVersion": "3",
    "activityDefId": "send_proposal",
    "processId": "208_crm_process1",
    "assigneeId": "admin",
    "description": "",
    "processName": "Proposal Approval Process",
    "dateCreated": "04-09-2015 03:05 AM",
    "participant": "Requester",
    "processDefId": "crm#3#process1",
    "variable": {
        "status": "approved"
    },
    "activityName": "Send Proposal"
}

Deprecated  Since v3, the concept of accept & withdraw assignment is removed  

ลักษณะ
ถอนการมอบหมายที่ยอมรับ

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/withdraw/879_223_crm_process1_approve_proposal

ตัวอย่างผลลัพธ์

{
    "activityId": "879_223_crm_process1_approve_proposal",
    "status": "withdrawn"
}

This API only works when the current user is assigned to the specified activity.

ลักษณะ
ตั้งค่าของตัวแปรเวิร์กโฟลว์ของการกำหนด

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม
• ตัวแปร - ตัวแปรเวิร์กโฟลว์เพื่อตั้งค่า
• ค่า - ค่าของตัวแปรเวิร์กโฟลว์

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/variable/843_208_crm_process1_send_proposal/status?value=test

ตัวอย่างผลลัพธ์

{"status":"variableSet"}

ลักษณะ
ดึงข้อมูลของการมอบหมาย

บทบาทของผู้ใช้

ทุกคน (รวมถึงบุคคลนิรนาม)

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/assignment/view/843_208_crm_process1_send_proposal

ตัวอย่างผลลัพธ์

{
    "activityId": "843_208_crm_process1_send_proposal",
    "processVersion": "3",
    "activityDefId": "send_proposal",
    "processId": "208_crm_process1",
    "assigneeId": "admin",
    "description": "",
    "processName": "Proposal Approval Process",
    "dateCreated": "04-09-2015 03:05 AM",
    "participant": "Requester",
    "processDefId": "crm#3#process1",
    "variable": {
        "status": "approved"
    },
    "activityName": "Send Proposal"
}

ลักษณะ
ยกเลิกอินสแตนซ์กระบวนการทำงาน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ

ตัวอย่าง URL
http://localhost:8080/jw/web/json/workflow/process/abort/208_crm_process1

ตัวอย่างผลลัพธ์

{"status":"aborted","processId":"208_crm_process1"}

ลักษณะ
รับ Process def Id ล่าสุดของกระบวนการตาม Process def Id

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processDefId - รหัสนิยามกระบวนการ (แทนที่ '#' ด้วย ':' ใน id)

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/process/latest/crm:1:process1

ตัวอย่างผลลัพธ์

{"id":"crm#3#process1","encodedId":"crm:3:process1"}

ลักษณะ
ดึงรายการกระบวนการ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• allVersion - (เป็นตัวเลือก) "ใช่" เพื่อโหลดทุกรุ่น "ไม่" เพื่อโหลดเวอร์ชันล่าสุด
• packageId - (ไม่บังคับ) รหัสแพ็คเกจ (รหัสแอป)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า
• checkWhiteList - (เป็นทางเลือกจริง / เท็จ) เพื่อส่งคืนรายการตามรายการกระบวนการสีขาว

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/process/list

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "desc": false,
    "sort": "name",
    "start": 0,
    "data": [{
        "id": "hdc_v1001#1#hdc_certification_process",
        "packageName": "halal certification",
        "name": "HDC Certification Process",
        "packageId": "hdc_v1001",
        "label": "HDC Certification Process ver 1",
        "version": "1"
    }, {
        "id": "mdec_v1002#12#mdec_wp1",
        "packageName": "Mdec Work Progress",
        "name": "mdec_wp1",
        "packageId": "mdec_v1002",
        "label": "mdec_wp1 ver 12",
        "version": "12"
    }, {
        "id": "mora#5#mora_new_application",
        "packageName": "MORA Halal Certification",
        "name": "MORA New Application",
        "packageId": "mora",
        "label": "MORA New Application ver 5",
        "version": "5"
    }]
}

ลักษณะ
ดึงข้อมูลกระบวนการแรกที่มีรายละเอียดของทุกแพ็คเกจ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• checkWhiteList - (เป็นทางเลือก) ค่าบูลีนเพื่อส่งคืนรายการตามรายการกระบวนการสีขาว

ตัวอย่าง URL
http:/localhost:8080/jw/web/json/workflow/process/list/package

ตัวอย่างผลลัพธ์

ลักษณะ
ยกเลิกกิจกรรมของอินสแตนซ์กระบวนการ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ
• activityDefId - id นิยามกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/abort/208_crm_process1/send_proposal

ตัวอย่างผลลัพธ์

{"activityDefId":"send_proposal","status":"aborted","processId":"208_crm_process1"}

ลักษณะ
ดึงรายการของกิจกรรมทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - (เป็นตัวเลือก) id อินสแตนซ์กระบวนการสำหรับการกรอง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/list?processId=116_hr_expense_process1

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "id": "474_116_hr_expense_process1_approve_claim",
        "serviceLevelMonitor": "-",
        "name": "Approve Claim",
        "state": "open.not_running.not_started",
        "dateCreated": "15-07-2015 02:54 AM"
    }, {
        "id": "472_116_hr_expense_process1_new_claim",
        "serviceLevelMonitor": "-",
        "name": "Edit Claim",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:53 AM"
    }, {
        "id": "473_116_hr_expense_process1_tool4",
        "serviceLevelMonitor": "-",
        "name": "Update Record Status to Submitted",
        "state": "closed.completed",
        "dateCreated": "15-07-2015 02:54 AM"
    }]
}

ลักษณะ
มอบหมายผู้ใช้อีกครั้งเพื่อแทนที่ผู้ใช้รายอื่นที่กำหนดให้กับการมอบหมาย

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อผู้ใช้ - ชื่อผู้ใช้ที่จะแทนที่ผู้ใช้ที่ได้รับมอบหมาย
• replaceUser - ชื่อผู้ใช้ของผู้รับโอนที่มีอยู่ของการมอบหมาย
• activityId - id อินสแตนซ์กิจกรรมของการมอบหมาย

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/reassign?activityId=841_206_crm_process1_send_proposal&username=admin&replaceUser=cat

ตัวอย่างผลลัพธ์

{"activityId":"841_206_crm_process1_send_proposal","username":"admin","replaceUser":"cat"}

ลักษณะ
ประเมินกิจกรรมอีกครั้ง

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• activityId - id อินสแตนซ์ของกิจกรรมที่ต้องประเมินใหม่

ตัวอย่าง URL

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

ลักษณะ
เริ่มกิจกรรมในอินสแตนซ์กระบวนการทำงาน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ
• activityDefId - id นิยามกิจกรรม
• abortCurrent - (เป็นทางเลือก) true ของค่าเท็จเพื่อยกเลิกกิจกรรมที่รันอยู่ทั้งหมดในอินสแตนซ์กระบวนการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/start/116_hr_expense_process1/verify_claim

ตัวอย่างผลลัพธ์

{"result":true,"activityDefId":"verify_claim","processId":"116_hr_expense_process1"}

ลักษณะ
ตั้งค่าให้กับตัวแปรเวิร์กโฟลว์เป็นอินสแตนซ์ของกิจกรรมที่ดำเนินอยู่

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม
• ตัวแปร - ชื่อตัวแปรเวิร์กโฟลว์
• value - ค่าตัวแปรเวิร์กโฟลว์

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/variable/474_116_hr_expense_process1_approve_claim/status?value=test

ตัวอย่างผลลัพธ์

{"status":"variableSet"}

ลักษณะ
ดึงข้อมูลของอินสแตนซ์กิจกรรม

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/activity/view/474_116_hr_expense_process1_approve_claim

ตัวอย่างผลลัพธ์

{
    "processId": "116_hr_expense_process1",
    "serviceLevelMonitor": "-",
    "createdTime": "Wed Jul 15 10:54:10 MYT 2015",
    "processName": "Expense Approval Process",
    "assignee": "admin",
    "activityId": "474_116_hr_expense_process1_approve_claim",
    "activityDefId": "approve_claim",
    "processVersion": "1",
    "processDefId": "hr_expense#1#process1",
    "participant": "approver",
    "finishTime": "",
    "variable": {
        "status": "test"
    },
    "activityName": "Approve Claim",
    "dueDate": ""
}

ลักษณะ
ดึงรายการของอินสแตนซ์กระบวนการที่เสร็จสมบูรณ์ทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• packageId - (ตัวเลือก) รหัสแอป / แพ็กเกจ
• processId - (เป็นตัวเลือก) id อินสแตนซ์กระบวนการสำหรับการกรอง
• processName - ชื่อกระบวนการ (ไม่บังคับ) สำหรับการกรอง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3

ตัวอย่างผลลัพธ์

{
    "total": 74,
    "data": [{
        "id": "133_hr_expense_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Expense Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "29-07-2015 01:46 AM",
        "version": "2"
    }, {
        "id": "135_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:28 AM",
        "version": "2"
    }, {
        "id": "136_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "closed.aborted",
        "due": "-",
        "startedTime": "04-08-2015 09:31 AM",
        "version": "2"
    }]
}

ลักษณะ
คัดลอกตัวแปรสถานะและเวิร์กโฟลว์ของอินสแตนซ์กระบวนการที่กำลังทำงานอยู่เพื่อเริ่มต้นอินสแตนซ์กระบวนการใหม่

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ
• processDefId - รหัสนิยามกระบวนการเพื่อเริ่มกระบวนการใหม่ (แทนที่ "#" เป็น ":")
• abortCurrent - (เป็นตัวเลือก) ค่าจริงหรือเท็จเพื่อยกเลิกอินสแตนซ์กระบวนการทำงานปัจจุบันหลังจากเริ่มอินสแตนซ์กระบวนการใหม่

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1

ตัวอย่างผลลัพธ์

{
    "processId": "228_hr_expense_process1",
    "processDefId": "hr_expense#1#process1",
    "activities": [ "896_228_hr_expense_process1_approve_claim" ]
}

ลักษณะ
ตั้งค่าเป็นตัวแปรเวิร์กโฟลว์ของอินสแตนซ์กระบวนการ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ
• ตัวแปร - ชื่อตัวแปรเวิร์กโฟลว์
• value - ค่าตัวแปรเวิร์กโฟลว์

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test

ตัวอย่างผลลัพธ์

{"status":"variableSet"}

ลักษณะ
ดึงข้อมูลของอินสแตนซ์กระบวนการ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• processId - id อินสแตนซ์ของกระบวนการ

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/process/view/224_crm_process1

ตัวอย่างผลลัพธ์

{
    "requester": "admin",
    "serviceLevelMonitor": "-",
    "processId": "224_crm_process1",
    "name": "Proposal Approval Process",
    "finishTime": "",
    "states": ["open.running", "open.running"],
    "packageId": "crm",
    "processDefId": "crm#3#process1",
    "dueDate": "",
    "startedTime": "",
    "version": "3"
}

ลักษณะ
เสร็จสิ้นการทำกิจกรรม

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• processDefId - รหัสนิยามกระบวนการ (แทนที่ "#" เป็น ":")
• processId - id อินสแตนซ์ของกระบวนการ
• activityId - id อินสแตนซ์ของกิจกรรม

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/running/activity/complete?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal

ลักษณะ
มอบหมายผู้ใช้อีกครั้งเพื่อแทนที่ผู้ใช้รายอื่นที่กำหนดให้กับการมอบหมาย

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• processDefId - รหัสนิยามกระบวนการ (แทนที่ "#" เป็น ":")
• processId - id อินสแตนซ์ของกระบวนการ
• activityId - id อินสแตนซ์ของกิจกรรม
• ชื่อผู้ใช้ - ชื่อผู้ใช้ที่จะแทนที่ผู้ใช้ที่ได้รับมอบหมาย
• replaceUser - ชื่อผู้ใช้ของผู้รับโอนที่มีอยู่ของการมอบหมาย

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin

ลักษณะ
ดึงรายการของอินสแตนซ์กระบวนการที่กำลังทำงานอยู่ทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• packageId - รหัสแอป / แพ็กเกจ (ไม่บังคับ)
• processId - (เป็นตัวเลือก) id อินสแตนซ์ของกระบวนการ
• processName - ชื่อกระบวนการ (ไม่บังคับ)
• version - เวอร์ชันกระบวนการ (เป็นทางเลือก)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3

ตัวอย่างผลลัพธ์

{
    "total": 16,
    "data": [{
        "id": "118_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "119_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }, {
        "id": "120_crm_process1",
        "serviceLevelMonitor": "-",
        "requesterId": "admin",
        "name": "Proposal Approval Process",
        "state": "open.running",
        "due": "-",
        "startedTime": "21-07-2015 03:03 AM",
        "version": "1"
    }]
}

ลักษณะ
ประเมินการมอบหมายทั้งหมดของผู้ใช้ใหม่

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

• ชื่อผู้ใช้ - ผู้ใช้ที่จะทำการประเมินใหม่

ตัวอย่าง URL

http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat

ลักษณะ
ดึงข้อมูลกระบวนการแรกที่มีรายละเอียดของทุกแพ็คเกจ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• appId - (เป็นตัวเลือก) รหัสการกำหนดแอป
• appVersion - เวอร์ชันข้อกำหนดแอป (เป็นตัวเลือก)
• processDefId - (เป็นตัวเลือก) id นิยามโปรเซสที่ไม่มี ID แพ็คเกจและเวอร์ชัน

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/activity/sla/list?appId=crm

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "ratioOnTime": 100,
        "activityDefId": "approval",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Approval"
    }, {
        "ratioOnTime": 100,
        "activityDefId": "parallel",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Parallel"
    }, {
        "ratioOnTime": 100,
        "activityDefId": "route1",
        "serviceLevelMonitor": "<span class=\"dot_green\">&nbsp;<\/span>",
        "minDelay": 0,
        "ratioWithDelay": 0,
        "maxDelay": 0,
        "activityName": "Route 1"
    }]
}

ลักษณะ
ดึงรายการของหลักฐานการตรวจสอบ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• dateFrom - (ไม่บังคับ) วันที่เริ่มต้นสำหรับการกรอง รูปแบบคือ yyyy-MM-dd
• dateTo - (เป็นตัวเลือก) วันที่สำหรับการกรอง รูปแบบคือ yyyy-MM-dd
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/audittrail/list?rows=5

ตัวอย่างผลลัพธ์

{
    "total": 3225,
    "data": [{
        "timestamp": "25-06-2015 07:41 AM",
        "message": "Authentication for user admin: true",
        "id": "2c90a1574e29523a014e29aa77590000",
        "username": "anonymousUser",
        "method": "authenticate",
        "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider"
    }, {
        "timestamp": "25-06-2015 08:41 AM",
        "message": "Authentication for user admin: true",
        "id": "2c90a1574e29e104014e29e178080000",
        "username": "anonymousUser",
        "method": "authenticate",
        "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "testProcess",
        "id": "2c90a1574e29e81c014e29eddb7a0000",
        "username": "admin",
        "method": "processUpload",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "50_testProcess_process1",
        "id": "2c90a1574e29e81c014e29eddecf0001",
        "username": "anonymousUser",
        "method": "processCompleted",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }, {
        "timestamp": "25-06-2015 08:55 AM",
        "message": "50_testProcess_process1",
        "id": "2c90a1574e29e81c014e29edded80002",
        "username": "anonymousUser",
        "method": "processCompleted",
        "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl"
    }]
}

ลักษณะ
ดึงแผนกทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - (ระบุหรือไม่ก็ได้) orgnization id
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/dept/list

ตัวอย่างผลลัพธ์

{
    "total": 7,
    "data": [{
        "id": "D-001",
        "description": "",
        "name": "CEO Office",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-002",
        "description": "",
        "name": "Human Resource and Admin",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-003",
        "description": "",
        "name": "Finance",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-004",
        "description": "",
        "name": "Marketing",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-005",
        "description": "",
        "name": "Product Development",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-006",
        "description": "",
        "name": "Training and Consulting",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }, {
        "id": "D-007",
        "description": "",
        "name": "Support and Services",
        "organization.name": "Joget.Org",
        "parent.name": ""
    }]
}

ลักษณะ
ดึงข้อมูลผู้ใช้ทั้งหมดพร้อมรายละเอียดการจ้างงาน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - (ไม่บังคับ) รหัสองค์กร
• deptId - (ไม่บังคับ) รหัสแผนก
• gradeId - (ตัวเลือก) รหัสเกรด
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/employment/list?name=j

ตัวอย่างผลลัพธ์

{
    "total": 2,
    "data": [{
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "organization.name": "Joget.Org",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Executives",
        "user.firstName": "Julia",
        "user.id": "julia",
        "role": null,
        "user.lastName": "Kapatelis",
        "organization.name": "Joget.Org",
        "employeeCode": null,
        "user.username": "julia",
        "department.name": "Human Resource and Admin"
    }]
}

ลักษณะ
ดึงผู้ใช้ทั้งหมดที่ไม่ได้อยู่ในองค์กรใด ๆ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/employment/noHaveOrganization/list

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "user.firstName": "Admin",
        "user.id": "admin",
        "role": "",
        "user.lastName": "",
        "employeeCode": "",
        "user.username": "admin"
    }
}

ลักษณะ
ดึงผู้ใช้ทั้งหมดที่ไม่ได้อยู่ในองค์กรใด ๆ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/employment/noInDept/list?orgId=ORG-001&deptId=D-003&name=j

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "grade.name": "Executives",
        "user.firstName": "Cat",
        "user.id": "cat",
        "role": "",
        "user.lastName": "Grant",
        "employeeCode": "",
        "user.username": "cat",
        "department.name": "Product Development"
    }, {
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Executives",
        "user.firstName": "Julia",
        "user.id": "julia",
        "role": null,
        "user.lastName": "Kapatelis",
        "employeeCode": null,
        "user.username": "julia",
        "department.name": "Human Resource and Admin"
    }]
}

ลักษณะ
ดึงผู้ใช้ทั้งหมดที่ไม่ได้อยู่ในเกรด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - รหัสองค์กร
• รหัสเกรด - รหัสเกรด
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/employment/noInGrade/list?orgId=ORG-001&gradeId=G-003&name=c

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "grade.name": "Managers",
        "user.firstName": "Clark",
        "user.id": "clark",
        "role": null,
        "user.lastName": "Kent",
        "employeeCode": null,
        "user.username": "clark",
        "department.name": "Product Development"
    }, {
        "grade.name": "Managers",
        "user.firstName": "Jack",
        "user.id": "jack",
        "role": null,
        "user.lastName": "Drake",
        "employeeCode": null,
        "user.username": "jack",
        "department.name": "Training and Consulting"
    }, {
        "grade.name": "Managers",
        "user.firstName": "David",
        "user.id": "david",
        "role": null,
        "user.lastName": "Cain",
        "employeeCode": null,
        "user.username": "david",
        "department.name": "Support and Services"
    }]
}

ลักษณะ
ดึงกลุ่มทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - (ไม่บังคับ) รหัสองค์กรสำหรับตัวกรอง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/group/list

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }, {
        "id": "G-002",
        "description": "",
        "name": "CxO",
        "organization.name": ""
    }, {
        "id": "G-003",
        "description": "",
        "name": "hrAdmin",
        "organization.name": ""
    }]
}

ลักษณะ
ดึงเกรดทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - (ไม่บังคับ) รหัสองค์กรสำหรับตัวกรอง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/grade/list

ตัวอย่างผลลัพธ์

{
    "total": 3,
    "data": [{
        "id": "G-001",
        "description": "",
        "name": "Board Members"
    }, {
        "id": "G-002",
        "description": "",
        "name": "Managers"
    }, {
        "id": "G-003",
        "description": "",
        "name": "Executives"
    }]
}

ลักษณะ
ดึงข้อมูลองค์กรทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/organization/list

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "id": "ORG-001",
        "description": "",
        "name": "Joget.Org"
    }
}

ลักษณะ
ดึงแผนกย่อยทั้งหมดของแผนก

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• deptId - รหัสแผนก
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/subdept/list?deptId=D-001

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "id": "sub",
        "description": "",
        "name": "Sub Department"
    }
}

ลักษณะ
ดึงแผนกและเกรดทั้งหมดในองค์กร

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/user/deptAndGrade/options?orgId=ORG-001

ตัวอย่างผลลัพธ์

{
    "departments": [{
        "id": "",
        "name": "",
        "prefix": ""
    }, {
        "id": "D-001",
        "prefix": "",
        "name": "CEO Office"
    }, {
        "id": "D-003",
        "prefix": "",
        "name": "Finance"
    }, {
        "id": "D-002",
        "prefix": "",
        "name": "Human Resource and Admin"
    }, {
        "id": "D-004",
        "prefix": "",
        "name": "Marketing"
    }, {
        "id": "D-005",
        "prefix": "",
        "name": "Product Development"
    }, {
        "id": "D-007",
        "prefix": "",
        "name": "Support and Services"
    }, {
        "id": "D-006",
        "prefix": "",
        "name": "Training and Consulting"
    }],
    "grades": [{
        "id": "",
        "name": "",
        "prefix": ""
    }, {
        "id": "G-001",
        "name": "Board Members"
    }, {
        "id": "G-003",
        "name": "Executives"
    }, {
        "id": "G-002",
        "name": "Managers"
    }]
}

ลักษณะ
ดึงกลุ่มที่ผู้ใช้อยู่หรือไม่

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• userId - ชื่อผู้ใช้ว่าผู้ใช้อยู่ในกลุ่มหรือไม่
• orgId - (ไม่บังคับ)
• inGroup - (เป็นตัวเลือก) จริงหรือเท็จ ค่าเริ่มต้นเป็นจริง
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/user/group/list?userId=admin

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "id": "G-001",
        "description": "",
        "name": "Managers",
        "organization.name": ""
    }
}

ลักษณะ
ดึงรายชื่อผู้ใช้

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
• orgId - (เป็นตัวเลือก) รหัสองค์กรสำหรับตัวกรอง
• deptId - (เป็นตัวเลือก) รหัสแผนกสำหรับตัวกรอง
• gradeId - (เป็นตัวเลือก) Grade id สำหรับตัวกรอง
• groupId - (เป็นตัวเลือก) id ของกลุ่มสำหรับตัวกรอง
• roleId - (เป็นทางเลือก) ID บทบาทสำหรับตัวกรอง
• ใช้งานได้ - (ไม่บังคับ) 1 = ใช้งาน, 0 = ไม่ทำงาน
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/user/list?groupId=G-002

ตัวอย่างผลลัพธ์

{
    "total": 1,
    "data": {
        "id": "terry",
        "lastName": "Berg",
        "username": "terry",
        "email": "",
        "active": "Active",
        "firstName": "Terry"
    }
}

ลักษณะ
ดึงรายชื่อผู้ใช้ที่ไม่ได้อยู่ในกลุ่ม

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
ชื่อ - ตัวกรองชื่อ (ไม่บังคับ)
groupId - รหัสกลุ่มสำหรับตัวกรอง
sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ

desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)

start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น

rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/admin/user/notInGroup/list?groupId=G-002

ตัวอย่างผลลัพธ์

{
    "total": 4,
    "data": [{
        "id": "admin",
        "lastName": "",
        "username": "admin",
        "email": "",
        "firstName": "Admin"
    }, {
        "id": "cat",
        "lastName": "Grant",
        "username": "cat",
        "email": "owen@joget.org",
        "firstName": "Cat"
    }, {
        "id": "clark",
        "lastName": "Kent",
        "username": "clark",
        "email": "",
        "firstName": "Clark"
    }, {
        "id": "david",
        "lastName": "Cain",
        "username": "david",
        "email": "",
        "firstName": "David"
    }]
}

ลักษณะ
ในการลงชื่อเพียงครั้งเดียวกับผู้ใช้

บทบาทของผู้ใช้

ไม่ระบุชื่อ

วิธี

HTTP GET / POST สนับสนุนการตรวจสอบสิทธิ์พื้นฐาน HTTP

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• j_username - ชื่อผู้ใช้ (ไม่บังคับ) สำหรับเข้าสู่ระบบ
• j_password - รหัสผ่าน (เป็นตัวเลือก) สำหรับการเข้าสู่ระบบ
• แฮช - (ไม่บังคับ) Hashed Password

ตัวอย่าง URL

http://localhost:8080/jw/web/json/directory/user/sso?j_username=admin&j_password=admin

ตัวอย่างผลลัพธ์

{"username":"admin","isAdmin":"true", "token": "OWASP_CSRFTOKEN=7BKT-GL1V-Y5LR-T3JJ-41W2-JRBL-CCDB-7C03"}

ลักษณะ
ดึงชื่อผู้ใช้ของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/web/json/workflow/currentUsername

ตัวอย่างผลลัพธ์

{"username":"admin"}

ลักษณะ
ดึงรายการของปลั๊กอิน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• className - (เป็นตัวเลือก) ชื่อคลาสของคลาส abstract ของประเภทปลั๊กอินหรืออินเตอร์เฟส
• เริ่ม - ที่แถวเริ่มต้นจาก
• rows - จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/plugin/list?start=0&rows=5

ตัวอย่างผลลัพธ์

{
    "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"
    }]
}

ลักษณะ
ดึงรายการของปลั๊กอิน OSGI

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• className - (เป็นตัวเลือก) ชื่อคลาสของคลาส abstract ของประเภทปลั๊กอินหรืออินเตอร์เฟส
• เริ่ม - ที่แถวเริ่มต้นจาก
• rows - จำนวนแถวต่อหน้า

ตัวอย่าง URL

http://localhost:8080/jw/web/json/plugin/listOsgi?start=0&rows=10

ตัวอย่างผลลัพธ์

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

ลักษณะ
ดึงตัวเลือกของปลั๊กอินขึ้นอยู่กับคลาสนามธรรมประเภทอินเตอร์เฟซหรืออินเตอร์เฟซ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

classname - ชื่อคลาส plugin type abstract class or interface 

ตัวอย่าง URL

http://localhost:8080/jw/web/property/json/getElements?classname=org.joget.plugin.base.DefaultApplicationPlugin

ตัวอย่างผลลัพธ์

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

ลักษณะ
ดึงตัวเลือกคุณสมบัติปลั๊กอินของปลั๊กอิน

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

• HTTP GET / POST
• พารามิเตอร์
• value - ชื่อคลาสปลั๊กอิน

ตัวอย่าง URL

http://localhost:8080/jw/web/property/json/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool

ตัวอย่างผลลัพธ์

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

ลักษณะ
ดึงตัวเลือกคุณสมบัติปลั๊กอินเริ่มต้นของปลั๊กอินตามเมตาของ App Definition

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• appId - รหัสนิยามแอป
• version - (เป็นทางเลือก) เวอร์ชัน Defintion ของแอป
• value - ชื่อคลาสปลั๊กอิน

ตัวอย่าง URL

http://localhost:8080/jw/web/property/json/crm/getDefaultProperties?value=org.joget.apps.app.lib.EmailTool

ตัวอย่างผลลัพธ์

{
    "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": []
}

ลักษณะ
ดึงตัวเลือกคุณสมบัติปลั๊กอินเริ่มต้นของปลั๊กอินตามเมตาของ App Definition

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

• appId - รหัสนิยามแอป
• version - (เป็นทางเลือก) เวอร์ชัน Defintion ของแอป
• value - ชื่อคลาสปลั๊กอิน

ตัวอย่าง URL

http://localhost:8080/jw/web/property/json/crm/getPropertyOptions?value=org.joget.apps.app.lib.BeanShellTool

ตัวอย่างผลลัพธ์

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

ลักษณะ
ยืนยันว่า URL นั้นถูกต้อง

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP HEAD

พารามิเตอร์

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

ตัวอย่าง URL
http://localhost:8080/jw/web/json/apps/verify?url=http%3A%2F%2Fwww.joget.org

ลักษณะ
ดึงข้อความทั้งหมดที่เพิ่มเข้าไปใน Manage Messages

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
• ตัวกรอง - (เป็นตัวเลือก) สตริงเพื่อกรองผลลัพธ์
• locale - รหัสภาษา (เป็นตัวเลือก) เพื่อกรองผลลัพธ์
• sort - ชื่อคอลัมน์ (เป็นทางเลือก) ที่จะเรียงลำดับ
• desc - (เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย)
• start - (เป็นทางเลือก) โดยที่แถวเริ่มต้น
• rows - (เป็นทางเลือก) จำนวนแถวต่อหน้า

ตัวอย่าง URL
http://localhost:8080/jw/web/json/console/setting/message/list

ตัวอย่างผลลัพธ์

{"total":1,"data":{"message":"搜索","id":"402880824fb19a77014fb5025ed80002","locale":"zh_CN","key":"general.method.label.search"}}

ลักษณะ
ดึงไวยากรณ์ Hash Variable ที่มีอยู่ทั้งหมด

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

ตัวอย่าง URL
http://localhost:8080/jw/web/json/hash/options

ตัวอย่างผลลัพธ์

["assignment.activityDefId", "assignment.activityId", "assignment.activityName", "assignment.assigneeId", "assignment.processDefId", "assignment.processId", 
"assignment.processName", "assignment.processRequesterId", "assignment.processVersion", "currentUser.active", "currentUser.email", "currentUser.firstName", 
"currentUser.lastName", "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", "request.characterEncoding", "request.contextPath", "request.header.NAME", "request.locale", 
"request.method", "request.pathInfo", "request.protocol", "request.queryString", "request.remoteAddr", "request.requestURI", "request.requestURL", "request.requestedSessionId", 
"request.scheme", "request.serverName", "request.serverPort", "request.servletPath", "requestParam.KEY", "user.USERNAME.active", "user.USERNAME.email", "user.USERNAME.firstName", 
"user.USERNAME.lastName", "user.USERNAME.timeZone", "variable.KEY"]

ลักษณะ
เพื่อทดสอบการเชื่อมต่อ JDBC

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• แหล่งข้อมูล - ชื่อโปรไฟล์ ไม่ได้ใช้.
• ไดรเวอร์ - ชื่อไดรเวอร์
• url - URL การเชื่อมต่อ
• ผู้ใช้ - ชื่อผู้ใช้
• รหัสผ่าน - รหัสผ่าน
• callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้

ตัวอย่าง URL
http://localhost:8080/jw/web/json/workflow/testConnection?datasource=default&driver=com.mysql.jdbc.Driver&url=jdbc%3Amysql%3A%2F%2Flocalhost%3A3306%2Fjwdb%3FcharacterEncoding%3DUTF-8&user=root&password=

ตัวอย่างผลลัพธ์

{"success":true,"datasource":"default"}

ลักษณะ
โหลดบันทึกแบบฟอร์มที่เฉพาะเจาะจง

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• appId - ID นิยามแอป
• formId - ID นิยามของแบบฟอร์ม
• primaryKeyValue - ค่าคีย์หลักสำหรับบันทึกแบบฟอร์ม
• includeSubformData - ทางเลือกตั้งค่าเป็นจริงเพื่อรวมข้อมูลฟอร์มย่อยซ้ำ
• includeReferenceElements - ทางเลือกตั้งค่าเป็นจริงเพื่อรวมข้อมูลจากองค์ประกอบอ้างอิงเช่น selectbox ฯลฯ
• flatten - ตัวเลือกตั้งค่าเป็นจริงเพื่อทำให้ข้อมูลเรียบลงในแผนที่คีย์ - ค่าระดับหนึ่ง

ตัวอย่าง URL
http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001

ตัวอย่างคำขอ cURL

curl -v -d "j_username=admin&j_password=admin" "http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001?includeSubformData=true&includeReferenceElements=true&flatten=true"

{
    "country": "",
    "dateCreated": "27-07-2015 04:26 AM",
    "address": "",
    "accountName": "001",
    "city": "",
    "dateModified": "20-10-2016 04:36 AM",
    "id": "001",
    "state": ""
}

ลักษณะ
สร้างหรือปรับปรุงแบบฟอร์มบันทึก

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

• appId - ID นิยามแอป
• formId - ID นิยามของแบบฟอร์ม
• primaryKeyValue - ค่าคีย์หลักสำหรับบันทึกแบบฟอร์ม

ตัวอย่าง URL
http://localhost:8080/jw/web/json/data/form/store/crm/crm_account/001

ตัวอย่างคำขอ cURL

curl -v -X POST -d "j_username=admin&j_password=admin&accountName=001%Updated&address=001%20Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

curl -v --header "Authorization: Basic YWRtaW46YWRtaW4=" -F "accountName=001 Updated" -F "address=001 Address" http://localhost:8080/jw/web/json/data/form/store/crm//crm_account/001

{
    "id": "001"
}

ลักษณะ
ลบบันทึกฟอร์มที่มีอยู่

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

• appId - ID นิยามแอป
• formId - ID นิยามของแบบฟอร์ม
• primaryKeyValue - ค่าคีย์หลักสำหรับบันทึกแบบฟอร์ม

ตัวอย่าง URL
http://localhost:8080/jw/web/json/data/form/delete/crm/crm_account/001

ตัวอย่างคำขอ cURL

curl -v -X POST -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/form/delete/crm//crm_account/001

{
    "id": "001"
}

ลักษณะ
โหลดเร็กคอร์ดจากตัวระบุข้อมูลเฉพาะ

บทบาทของผู้ใช้

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

• appId - ID นิยามแอป
• listId - ID นิยามการกำหนดข้อมูล
• start - ดัชนีเริ่มต้นทางเลือก (เริ่มต้นที่ 0)
• rows - จำนวนแถวที่เป็นทางเลือกที่จะส่งคืน
• พารามิเตอร์คำขอ URL - ตัวกรองเพิ่มเติม (เช่น d-5043735-fn_accountName)

ตัวอย่าง URL
http://localhost:8080/jw/web/json/data/list/crm/crm_account_list

ตัวอย่างคำขอ cURL

curl -v -d "j_username=admin&j_password=admin" http://localhost:8080/jw/web/json/data/list/crm/crm_account_list?start=0&rows=20&d-5043735-fn_accountName=00

The returned attribute "total" will give the the total number of records regardless of the filters applied unless the attribute "Consider filter value when get total size?" is checked in the datalist.