Page History

Tip

icon	false

Do check out the API Builder! A brand new custom builder plugin made for Joget DX.

The API Builder introduces the simple drag-and-drop principle similar to the Form Builder, as a no-code/low-code alternative to create your own customized JSON APIs for Joget apps.

Have access to more APIs out-of-the-box, preview APIs quickly, greater API access management, support for custom API authenticators, and more.

API elements & API authenticators are extensible via plugins too.

To see detailed information about this plugin, click here.

Download the plugin from Joget Marketplace here.

Warning

English
The

Warning

Introduced in v5, 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.

Thai

มีการแนะนำใน v5 การตั้งค่ารายการที่อนุญาตพิเศษของโดเมน API ใน General Settings จำเป็นต้องได้รับการกำหนดค่าให้อนุญาตการร้องขอ JSON API หากคำขอมาจากโดเมนที่ไม่ใช่รายการที่อนุญาตพิเศษการตอบกลับจะเป็น HTTP 400 Bad Request

Panel

borderColor	purple
borderWidth	1
titleBGColor	#ddccff
borderStyle	solid
title	New Feature

Form Data API and List Data API are newly added feature in Joget Workflow v6.

Thai
Form Data API และ List Data API เป็นคุณสมบัติที่เพิ่มเข้ามาใหม่ใน Joget Workflow v6

Table of Contents

indent	30px
style	circle

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ แอป app/ CRM crm/ รูปแบบ form/crm_account/ คอลัมน์columns

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ แอป app/ CRM crm/ เครื่องกำเนิดไฟฟ้า generator/crm_account/ สร้างปลั๊กอิน generate?plugin=org.joget.plugin.enterprise.CrudGenerator

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/ เว็บ web/json/ แอพ apps/ ติดตั้งinstall?url= http% 3A% 2F% 2Fwwwhttp%3A%2F%2Fwww.joget.org% 2Fdownloads% 2Fsimpleorg%2Fdownloads%2Fsimple_crm.jwa

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ปพลิเคชัน apps/ ตีพิมพ์ / กระบวนการ AppID = CRMpublished/processes?appId=crm

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ปพลิเคชัน apps/ ตีพิมพ์ published/userviews AppID ?appId= CRMcrm

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/app/ รายชื่อ list?name= CRMcrm

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http:/localhost/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ รายการ list/ แพ็กเกจpackage

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ สร้าง builder/ การกระทำactions

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/envVariable/ รายการlist

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/datalist/ รายการlist

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/datalist/ ตัวเลือกoptions

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ รูปแบบ form/tableNameList

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ รูปแบบforms

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ แบบ forms/ ตัวเลือกoptions

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ แพคเกจ package/ ปรับใช้deploy

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

Code Block

language	js

{"status" : "complete"}

...

- appId - App Definition id
- version - (Optional) App Definition version

Sample URL

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

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ แพคเกจ package/ XPDLxpdl

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/pluginDefault/ รายการlist

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ ข้อความ message/ รายการlist

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

Code Block

language	js

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

...

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ UserView userview/ รายการlist

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ คอนโซล console/ แอป app/ CRM crm/ UserView userview/ ตัวเลือกoptions

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ แพคเกจ package/ รายการlist

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

Code Block

language	js

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

...

Thai

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

Note
เลิกใช้ตั้งแต่ v3 แนวคิดการยอมรับและถอนการมอบหมายจะถูกลบออก

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ ยอมรับ accept/879_223_crm_process1_approve_proposal

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/complete/879_223_crm_process1_approve_proposal สมบูรณ์

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

Code Block

language	js

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

...

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

...

Thai

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/ เว็บ web/json/ เวิร์กโฟลว์ workflow/ การมอบหมาย assignment/ สมบูรณ์ completeWithVariable/879_223_crm_process1_approve_proposal?var_status= ส่งแล้วSent

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การกำหนดรายการ assignment/ แถว list?rows=3& PackageID packageId= CRMcrm

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ รายการ / นับ PackageID = CRMlist/count?packageId=crm

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

Code Block

language	js

{"total":10}

...

Thai

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

Note
เลิกใช้ตั้งแต่ v3 แนวคิดการยอมรับและถอนการมอบหมายจะถูกลบออก

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ รายการ list/ ยอมรับแถว accepted?rows=3

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

Code Block

language	js

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

...

Thai

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

Note
เลิกใช้ตั้งแต่ v3 แนวคิดการยอมรับและถอนการมอบหมายจะถูกลบออก

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/jw/ เจดับบลิว web/ เว็บ json/ JSON workflow/ ขั้นตอนการทำงาน assignment/ การมอบหมาย list/ รายการ accepted/ ยอมรับแถว = 3count

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

Code Block

language	js

{"total":3}

...

Thai

ลักษณะ

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

Note
เลิกใช้ตั้งแต่ v3 แนวคิดการยอมรับและถอนการมอบหมายจะถูกลบออก

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ รายการ list/ ยอมรับ accepted/ กระบวนการprocess

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/list/ รายการอยู่ระหว่างดำเนินการpending

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/list/ รายการที่รอดำเนินการ pending/ นับcount

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

Code Block

language	js

{"total":3}

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http:/localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/list/ รายการที่รอดำเนินการ pending/ กระบวนการprocess

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

Code Block

language	js

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

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ กระบวนการ process/view/208_crm_process1

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

Code Block

language	js

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

...

Thai

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

Note
เลิกใช้ตั้งแต่ v3 แนวคิดการยอมรับและถอนการมอบหมายจะถูกลบออก

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/ ถอน withdraw/879_223_crm_process1_approve_proposal

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

Code Block

language	js

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

web/json/workflow/assignment/variable/(:activityId)/(:variable)

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

Description
Sets value of workflow variable of an assignment

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- activityId - activity instance id
- variable - workflow variable to set value
- value - value of workflow variable

Sample URL

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

Sample Result

Thai

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

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

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

วิธี

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

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

Code Block

language	js

{"status":"variableSet"}

...

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ การมอบหมาย assignment/view/843_208_crm_process1_send_proposal

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL
http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ ยกเลิก abort/208_crm_process1

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ ล่าสุด latest/ CRMcrm:1: กระบวนการ 1process1

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ รายการlist

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL
http:/localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ รายการ list/ แพ็กเกจpackage

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

Code Block

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

web/json/workflow/process/start/(*:processDefId)

Description
Starts a process based on process start whitelist

User Role

Anyone (Including anonymous)

Method

HTTP POST

Parameters

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

processDefId - Process Definition Id (Replace '#' with ':' in the id)

Info

title	Obtaining Latest Published Process Version

Instead of specifying crm:3:process1 in the call, we can use the keyword latest in the processDefId - crm:latest:process1 to automatically set to the published app's process version.

processInstanceId - (Optional) used to start the previous created but haven't start process instance
recordId - (Optional) used to start a process instance with existing record
var_* - (Optional) parameters prefixed with "var_" will be used to set workflow variable

Sample URL

http://localhost:8080/jw/web/json/workflow/process/start/crm:3:process1

Sample Result

Thai

ลักษณะ
เริ่มกระบวนการตามรายการที่อนุญาตในการเริ่มกระบวนการ

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

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

วิธี

HTTP POST

พารามิเตอร์

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

processDefId - รหัสนิยามกระบวนการ (แทนที่ '#' ด้วย ':' ใน id)

Info

title	Obtaining Latest Published Process Version

แทนที่จะระบุ crm: 3: process1 ในการโทรเราสามารถใช้คำสำคัญล่าสุดใน processDefId - crm: ล่าสุด: process1 เพื่อตั้งค่าให้เป็นรุ่นกระบวนการของแอปที่เผยแพร่โดยอัตโนมัติ

processInstanceId - (เป็นตัวเลือก) ใช้เพื่อเริ่มสร้างก่อนหน้านี้ แต่ยังไม่ได้เริ่มต้นอินสแตนซ์กระบวนการ
recordId - (เป็นทางเลือก) ใช้เพื่อเริ่มต้นอินสแตนซ์กระบวนการด้วยระเบียนที่มีอยู่
var_ * - (พารามิเตอร์เสริม) นำหน้าด้วย "var_" จะถูกใช้เพื่อตั้งค่าตัวแปรเวิร์กโฟลว์

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ เริ่มต้น start/ CRMcrm:3: กระบวนการ 1process1

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

Code Block

language	js

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

Note

For "activityId" to be returned, please ensure the "Show The Next Assignment When Completed" is checked under the Run Process activity in Map Activities to Forms tab and the next activity after the start of process is assigned to the same person that starts the process.

Thai

สำหรับการส่งคืน "activityId" โปรดตรวจสอบว่า "แสดงการมอบหมายต่อไปเมื่อเสร็จสมบูรณ์" ถูกเลือกภายใต้กิจกรรม Run Process ในแท็บ Map Activities to Forms และกิจกรรมถัดไปหลังจากกำหนดกระบวนการเริ่มต้นให้กับบุคคลเดียวกันที่เริ่ม กระบวนการ.

web/json/workflow/process/variable/(:processId)/(:variable)

Description
Sets workflow variable of a process instance

User Role

Admin

Method

HTTP POST

Parameters

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process instnace id
- variable - workflow variable name
- value - value of workflow variable to be set

Sample URL

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/ ตัวแปร variable/208_crm_process1/ สถานะ status?value= ทดสอบtest

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

Code Block

language	js

{"status" : "variableSet"}

web/json/workflow/process/view/(*:processId)

Description
Retrieves information of a process definition

User Role

Admin

Method

HTTP GET/POST

Parameters

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - Process Definition Id (Replace '#' with ':' in the id)

Sample URL

http://localhost:8080/jw/web/json/workflow/process/view/crm:3:process1

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ กระบวนการ process/view/ CRMcrm:3: กระบวนการ 1process1

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

Code Block

language	js

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

web/json/workflow/variable/list/(*:processId)

Description
Retrieves all variables of a process instance

User Role

Admin

Method

HTTP GET/POST

Parameters

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process instance id

Sample URL

http://localhost:8080/jw/web/json/workflow/variable/list/208_crm_process1

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ขั้นตอนการทำงาน workflow/ ตัวแปร variable/ รายการ list/208_crm_process1

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ตรวจสอบ monitoring/ กิจกรรม activity/ ยกเลิก abort/208_crm_process1/send_proposal

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ตรวจสอบ monitoring/ กิจกรรม / รายการ ProcessID activity/list?processId=116_hr_expense_process1

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

Code Block

language	js

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

...

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http://localhost:8080/ เจดับบลิว jw/ เว็บ web/ JSON json/ ตรวจสอบ monitoring/ กิจกรรม / มอบหมาย ActivityId activity/reassign?activityId=841_206_crm_process1_send_proposal&username= ผู้ดูแลระบบและ admin&replaceUser= แมวcat

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

Code Block

language	js

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

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process instance id
- activityDefId - activity definition id
- abortCurrent - (Optional) true of or false value to abort all the running activities in the process instance

...

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

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

SLA

web/json/workflow/activity/sla/list

...

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

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

web/json/plugin/listOsgi

Description
Retrieves a list of OSGI plugins

User Role

Admin

...

web/json/plugin/listOsgi

Description
Retrieves a list of OSGI plugins

User Role

Admin

Method

HTTP GET/POST

Parameters

- className - (Optional) class name of plugin type abstract class or interface
- start - where rows start from
- rows - number of rows per page

Sample URL

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

...

พารามิเตอร์

...

className - (

...

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

ตัวอย่าง

...

start - where rows start from

...

rows - number of rows per page

...

URL

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

...

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

Code Block

language	js

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

...

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

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

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

Code Block

language	js

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

web/property/json/getPropertyOptions

Description
Retrieves the Plugin Properties Options of a plugin

User Role

Admin

...

"
}]

web/property/json/getPropertyOptions

Description
Retrieves the Plugin Properties Options of a plugin

User Role

Admin

Method

HTTP GET/POST

Parameters

- value - Plugin class name

Sample URL

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

...

พารามิเตอร์
value -

...

ชื่อคลาสปลั๊กอิน

...

ตัวอย่าง URL

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

...

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

Code Block

language	js

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

...

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

Sample Result

Thai

ลักษณะ
ดึงตัวเลือกคุณสมบัติปลั๊กอินเริ่มต้นของปลั๊กอินตามเมตาของ 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

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

Code Block

language	js

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

...

- appId - App Definition Id
- version - (Optional) App Defintion version
- value - Plugin class name

...

- version
- value - Plugin class name

Sample URL

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

Sample Result

Thai

ลักษณะ
ดึงตัวเลือกคุณสมบัติปลั๊กอินเริ่มต้นของปลั๊กอินตามเมตาของ 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

...

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

Code Block

language	js

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

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- filter - (Optional) string to filter the results
- locale - (Optional) language code to filter the results
- sort - (Optional) column name to be sortedsorted
- 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/setting/message/list

Sample Result

Thai

ลักษณะ
ยืนยันว่า 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

...

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

Code Block

language	js

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

...

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

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

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

Code Block

language	js

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

...

Method
HTTP GET/POST

Parameters

- datasource - Profile name. Not used.
- driver - driver name
- url - connection URL
- user - username
- password - password
- callback - (Optional) a function (in JavaScript) to call back after invoking this method

Sample 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=

Sample Result

Thai

ลักษณะ
เพื่อทดสอบการเชื่อมต่อ 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=

...

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

Code Block

language	js

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

...

Sample URL
http://localhost:8080/jw/web/json/data/form/load/crm/crm_account/001

Sample cURL Request

Thai

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

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

ผู้ดูแลระบบ

วิธี
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

Code Block

language	js

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"

...

Description
Create or update a form record

User Role

Admin

...

form record

User Role

Admin

Method
HTTP POST

Parameters

- appId - App definition ID
- formId - Form definition ID
- primaryKeyValue - The primary key value for the form record

Sample URL
http://localhost:8080/jw/web/json/data/form/store/crm/crm_account/001

Sample cURL Request

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP POST

...

พารามิเตอร์

...

appId -

...

ID นิยามแอป
formId -

...

ID นิยามของแบบฟอร์ม
primaryKeyValue -

...

ค่าคีย์หลักสำหรับบันทึกแบบฟอร์ม

ตัวอย่าง

...

URL
http://localhost:8080/jw/web/json/data/form/store/crm/crm_account/001

...

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

...

Code Block

language	js

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

...

Sample URL
http://localhost:8080/jw/web/json/data/form/delete/crm/crm_account/001

Sample cURL Request

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

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

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

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

Code Block

language	js

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

...

Sample URL
http://localhost:8080/jw/web/json/data/list/crm/crm_account_list

Sample cURL Request

Thai

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

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

ผู้ดูแลระบบ

วิธี
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

Code Block

language	js

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

...

Info

title	Important Note

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.

Thai

แอตทริบิวต์ที่ส่งคืน "ผลรวม" จะให้จำนวนรวมของระเบียนโดยไม่คำนึงถึงตัวกรองที่ใช้เว้นแต่ว่าแอตทริบิวต์ "พิจารณาค่าตัวกรองเมื่อได้รับขนาดทั้งหมด" ถูกตรวจสอบใน datalist

Code Block

language	js

{
    "total": 5,
    "data": [{
        "country": "",
        "accountName": "001 Updated",
        "id": "001",
        "state": ""
    }, {
        "country": "",
        "accountName": "002",
        "id": "002",
        "state": ""
    }, {
        "country": "",
        "accountName": "003",
        "id": "003",
        "state": ""
    }]
}

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

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

web/json/workflow/assignment/variable/(:activityId)/(:variable)

web/json/workflow/process/start/(*:processDefId)

web/json/workflow/process/variable/(:processId)/(:variable)

web/json/workflow/process/view/(*:processId)

web/json/workflow/variable/list/(*:processId)

SLA

web/json/workflow/activity/sla/list

web/json/plugin/listOsgi

web/json/plugin/listOsgi

web/property/json/getPropertyOptions

web/property/json/getPropertyOptions

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

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

web/json/workflow/assignment/variable/(*:activityId)/(*:variable)

web/json/workflow/process/start/(*:processDefId)

web/json/workflow/process/variable/(*:processId)/(*:variable)

web/json/workflow/process/view/(*:processId)

web/json/workflow/variable/list/(*:processId)

SLA

web/json/workflow/activity/sla/list

web/json/plugin/listOsgi

web/json/plugin/listOsgi

web/property/json/getPropertyOptions

web/property/json/getPropertyOptions

web/json/workflow/assignment/variable/(:activityId)/(:variable)

web/json/workflow/process/variable/(:processId)/(:variable)