Page History

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

...

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

Description

...

Retrieves all columns for a form

...

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

User Role

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

Admin

Thai
ผู้ดูแลระบบ

Method

...

HTTP GET/POST

Parameters

...

- appId - App definition id
  ThaiappId - รหัสนิยามแอป
- version - (Optional) App definition version
  Thaiเวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
- formId - Form definition Id
  thai
  formId - รหัสคำจำกัดความของแบบฟอร์ม

Sample URL

...

URL

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / แอป / CRM / รูปแบบ / crm_account / คอลัมน์

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

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

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

Description

...

Executes a generator plugin based on a form

...

User Role

...

Admin

...

Method

...

HTTP POST

Parameters

...

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

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

plugin - Class name of generator plugin to execute
thai
appId -
รหัสนิยามแอป
appId - App Definition id
Thai
พารามิเตอร์
version - (Optional) App definition version
Thai
เวอร์ชัน - (เป็นตัวเลือก) เวอร์ชันคำจำกัดความของแอป
formId - Form defintion id
ThaiformId -
id
การกำหนดรูปแบบ

Sample URL

...

URL

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / แอป / CRM / เครื่องกำเนิดไฟฟ้า / crm_account / สร้างปลั๊กอิน = 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
}

web/json/apps/install

Description

...

Downloads and imports an app form an URL

...

URL

User Role

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

Admin

...

Method

...

HTTP POST

Parameters

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

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
  Thaicallback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
- url - Url to download an app
  Thaiurl - Url เพื่อดาวน์โหลดแอป

Sample URL

...

URL

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

Sample Result

Thai

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

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

{
    "appId"

Code Block

language	js

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

web/json/apps/published/processes

Description

Thai
ลักษณะ

Retrieves all published processes based on logged in user

...

User Role

...

Anyone (Including anonymous)

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

Method

Thai
กระบวนการ

HTTP GET/POST

Parameters

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
  Thaicallback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อเรียกกลับหลังจากเรียกใช้วิธีนี้
- appId - (Optional) App definition Id to filter the list
  thai
  appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

Sample URL

...

URL

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

Sample Result

Thai

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

ลักษณะ

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ปพลิเคชัน / ตีพิมพ์ / กระบวนการ AppID = CRM

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

Code Block

language	js

{
    "apps": [{

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

web/json/apps/published/userviews

Description

...

ลักษณะ

Retrieves all published userviews based on logged in user

...

User Role

...

Anyone (Including anonymous)

...

)

Method

...

HTTP GET/POST

Parameters

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
  thai
  callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อเรียกกลับหลังจากเรียกใช้วิธีนี้
- appId - (Optional) App definition Id to filter the list
  Thai
  appId - (เป็นตัวเลือก) รหัสคำจำกัดความแอปเพื่อกรองรายการ

Sample URL

...

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

Sample Result

Thai

ลักษณะ

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ปพลิเคชัน / ตีพิมพ์ / userviews AppID = CRM

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

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

web/json/console/app/list

Description

...

ลักษณะ

Retrieves all apps

User Role

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- sort - (Optional) column name to be sorted
- desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
- start - (Optional) where rows start from
- rows - (Optional) number of rows per page

Sample URL

...

URL

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

Sample Result

codelanguage

Thai

ลักษณะ

ตัวอย่างผลลัพธ์ดึงแอพทั้งหมด

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

ผู้ดูแลระบบ

js

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / app / รายชื่อ = CRM

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

Code Block

language	js

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

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

Description

...

Retrieves all version of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

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

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

Description

Thai
ลักษณะ

Retrieves Retrieves all Datalist Actions plugins

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

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

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

Description

...

Retrieves all environment variable of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

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

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

Description

Thai
ลักษณะ

Retrieves all datalist of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

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

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

Description

...

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

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / datalist / ตัวเลือก

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

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {

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

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

Description

...

Retrieves all table name used in an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / รูปแบบ / tableNameList

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

Code Block

language	js

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

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

Description

...

Retrieves all forms in an app

...

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

Sample Result

language

Code Blockthai

ลักษณะ

js

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / รูปแบบ

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

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

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

Description

...

Retrieves all form in an app in value-label pair

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / แบบ / ตัวเลือก

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

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

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

Description

Thai
ลักษณะ

Deploy Deploy a new version of XPDL to an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / แพคเกจ / ปรับใช้

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

Code Block

language	js

{"status" : "complete"}

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

Description

Thai
ลักษณะ

Retrieves XPDL file of an app

...

- 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 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / แพคเกจ / XPDL

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

Description

...

Retrieves all configured default plugin properties of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

{
    "total": 2,

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

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

Description

...

Retrieves all created custom i18n message of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / ข้อความ / รายการ

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

Code Block

language	js

{
    "total": 1,
    "data": {

Code Block

language	js

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

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

Description

Thai
ลักษณะ

Retrieves all userviews of an app

...

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

Sample Result

Thai

ลักษณะ

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / UserView / รายการ

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

Code Block

language	js

{
    "total": 1,
    "data": {

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

...

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / คอนโซล / แอป / CRM / UserView / ตัวเลือก

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

Code Block

language	js

[{
    "value": "",
    "label": ""
}, {

Code Block

language	js

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

...

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

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

...

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

Sample Result

Thai

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

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

{
    "assignment" :

Code Block

language	js

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

...

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

Sample Result

Thai

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การมอบหมาย / / 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/complete/879_223_crm_process1_approve_proposal ?var_status=Sent

Sample Result

Thai

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / jw / เว็บ / json / เวิร์กโฟลว์ / การมอบหมาย / สมบูรณ์ / 879_

Code Block

language	js

{ "activityId": "879_

223_crm_process1_approve_proposal? var_status = ส่งแล้ว

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

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/list?rows=3&packageId=crm

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การกำหนดรายการ / แถว = 3 & PackageID = CRM

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

Code Block

language	js

{
    "total": 10,
    "data": [{
        "id":

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

...

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

Sample Result

language

Code Blockthai
ลักษณะ		js
{"total":10}

web/json/workflow/assignment/list/accepted

Description
Retrieves all accepted assignments of current logged in user

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

User Role

Anyone (Including anonymous)

...

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

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

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

วิธี

HTTP GET / POST

...

พารามิเตอร์

callback - (

...

เป็นตัวเลือก)

...

ฟังก์ชั่น (

...

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การมอบหมาย / รายการ / นับ PackageID = CRM

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

Code Block

language	js

{"total":10}

web/json/workflow/assignment/list/accepted

Description
Retrieves all accepted assignments of current logged in user

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

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- to call back after invoking this methodprocessId - (Optional) Process instance id
- sort - (Optional) column name to be sorted
- desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
- start - (Optional) where rows start from
- rows - (Optional) number of rows per page

...

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

Sample Result

Thai

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

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

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

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

Code Block

language	js

{
    "total": 10,
    "

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

...

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

Sample Result

Code Blockthai

language	js

{"total":3}

web/json/workflow/assignment/list/accepted/process

Description

...

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

Note

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

User Role

Anyone (Including anonymous)

...

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

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

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

วิธี

HTTP GET / POST

...

พารามิเตอร์

callback - (

...

เป็นตัวเลือก)

...

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

ตัวอย่าง URL

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

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

Code Block

language	js

{"total":3}

web/json/workflow/assignment/list/accepted/process

Description

Retrieves processes list based on accepted assignment of current logged in user

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

User Role

Anyone (Including anonymous)

Method

HTTP GET/POST

Parameters

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

...

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

Sample Result

Thai

ลักษณะ

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

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การมอบหมาย / รายการ / ยอมรับ / กระบวนการ

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

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

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - (Optional) Process instance id
- 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/workflow/assignment/list/pending

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

...

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

...

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

...

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

ตัวอย่าง

...

URL

http: // localhost: 8080 /

...

เจดับบลิว /

...

เว็บ /

...

JSON /

...

ขั้นตอนการทำงาน /

...

การมอบหมาย /

...

/

...

รายการอยู่ระหว่างดำเนินการ

...

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

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

...

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

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การมอบหมาย / / รายการที่รอดำเนินการ / นับ

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

Code Block

language	js

{"total":3}

...

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

callback - (

...

เป็นตัวเลือก)

...

ฟังก์ชั่น (

...

ใน JavaScript)

...

เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้

ตัวอย่าง URL

...

http: / localhost: 8080 /

เจดับบลิว /

เว็บ /

JSON /

ขั้นตอนการทำงาน /

การมอบหมาย /

/

รายการที่รอดำเนินการ /

...

กระบวนการ

...

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

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

...

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

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / การมอบหมาย / กระบวนการ / 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"
}

...

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

Sample URL

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

Sample Result

Thai

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

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

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

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

วิธี

HTTP POST

พารามิเตอร์

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

ตัวอย่าง URL

http: // localhost: 8080 /

เจดับบลิว /

เว็บ /

JSON /

ขั้นตอนการทำงาน /

การมอบหมาย /

ถอน / 879_223_crm_process1_approve_proposal

...

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

Code Block

language	js

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

...

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

...

Anyone (Including anonymous) Method

Method

HTTP GET/POST

Parameters

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

Sample URL

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

Sample Result

Thai

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

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

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

วิธี

HTTP GET / POST

...

พารามิเตอร์

callback - (

...

เป็นตัวเลือก)

...

ฟังก์ชั่น (

...

ใน JavaScript)

...

เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้
activityId -

...

id อินสแตนซ์ของกิจกรรม

...

ตัวอย่าง URL

http: // localhost: 8080 /

...

เจดับบลิว /

...

เว็บ /

...

JSON /

...

ขั้นตอนการทำงาน /

...

การมอบหมาย / 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"
}

...

Sample URL
http://localhost:8080/jw/web/json/workflow/process/abort/208_crm_process1

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP POST

พารามิเตอร์

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

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

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

Code Block

language	js

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

...

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

Sample URL

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

...

ตัวอย่าง URL

http: // localhost: 8080 /

...

เจดับบลิว /

...

เว็บ /

...

JSON /

...

ขั้นตอนการทำงาน /

...

กระบวนการ /

...

ล่าสุด /

...

CRM: 1:

...

กระบวนการ 1

...

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

Code Block

language	js

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

...

- callback - (Optional) a function (in JavaScript) to call back after invoking this methodthis method
- allVersion - (Optional) "yes" to load all versions, "no" to load latest version
- packageId - (Optional) package id (App id)
- sort - (Optional) column name to be sorted
- desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
- start - (Optional) where rows start from
- rows - (Optional) number of rows per page
- checkWhiteList - (Optional true/false) to return the list based on process white list

Sample URL

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

พารามิเตอร์

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

...

เป็นตัวเลือก)

...

"

...

ใช่" เพื่อโหลดทุกรุ่น "ไม่" เพื่อโหลดเวอร์ชันล่าสุด
packageId - (

...

ไม่บังคับ)

...

รหัสแพ็คเกจ (

...

รหัสแอป)
sort - ชื่อคอลัมน์ (

...

เป็นทางเลือก) ที่จะเรียงลำดับ
desc - (

...

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

...

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

...

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

...

เป็นทางเลือกจริง /

...

เท็จ) เพื่อส่งคืนรายการตามรายการกระบวนการสีขาว

ตัวอย่าง

...

URL

http: // localhost: 8080 /

...

เจดับบลิว /

...

เว็บ /

...

JSON /

...

ขั้นตอนการทำงาน /

...

กระบวนการ /

...

รายการ

...

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

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

...

Description
Retrieve first process with details of every packages

User Role

Admin

...

Admin

Method
HTTP GET/POST

Parameters

- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- checkWhiteList - (Optional) Boolean value to return the list based on process white list

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

Sample Result

Thai

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

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

ผู้ดูแลระบบ

วิธี
HTTP GET / POST

...

พารามิเตอร์

callback - (

...

เป็นตัวเลือก)

...

ฟังก์ชั่น (

...

ใน JavaScript)

...

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

...

เป็นทางเลือก) ค่าบูลีนเพื่อส่งคืนรายการตามรายการกระบวนการสีขาว

ตัวอย่าง

...

URL
http: / localhost: 8080 /

...

เจดับบลิว /

...

เว็บ /

...

JSON /

...

ขั้นตอนการทำงาน /

...

กระบวนการ /

...

รายการ /

...

แพ็กเกจ

...

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

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 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / กระบวนการ / เริ่มต้น / CRM: 3: กระบวนการ 1

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

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.

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

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

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

Code Block

language	js

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

...

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

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

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

web/json/apps/install

web/json/apps/published/processes

web/json/apps/published/userviews

web/json/console/app/list

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

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

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

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

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

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

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

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

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

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

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

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

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

web/json/workflow/assignment/list/accepted

web/json/workflow/assignment/list/accepted

web/json/workflow/assignment/list/accepted/process

web/json/workflow/assignment/list/accepted/process

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)

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

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

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

web/json/apps/install

web/json/apps/published/processes

web/json/apps/published/userviews

web/json/console/app/list

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

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

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

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

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

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

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

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

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

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

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

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

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

web/json/workflow/assignment/list/accepted

web/json/workflow/assignment/list/accepted

web/json/workflow/assignment/list/accepted/process

web/json/workflow/assignment/list/accepted/process

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)

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

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

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