Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Assume that the process definition id is CRM#1#newpkg1_wp1, the username & password is admin, and the base URL of http://localhost:8080/jw/.

In this case:

  • CRM is package id
  • 1 is version of process you want to refer to as this case it's newpkg1_wp1
  • newpkg1_wp1 is process id

If you not sure which package and process you have, you can use api the check what is your latest package, version, process you have in hand by http://localhost:8080/jw/web/json/workflow/process/list

Your api response could be as below:

{"packageId":"CRM","name":"new package 1 work process 1","id":"CRM#1#newpkg1_wp1","packageName":"CRM","label":"newpkg1 wp1 ver 1","version":"1"}

Thai

สมมติว่า id นิยามกระบวนการคือ CRM # 1 # newpkg1_wp1 ชื่อผู้ใช้และรหัสผ่านคือผู้ดูแลระบบและ URL พื้นฐานของ http://localhost:8080/jw/

โดยในที่นี้

  • CRM คือ package id
  • 1 คือ version ของ process
  • newpkg1_wp1 คือ process id

หากคุณไม่แน่ใจว่าจะใช้ package หรือ process อะไร คุณสามารถใช้ api เพื่อตรวจสอบ package, version, process ล่าสุดที่คุณทำไว้แล้วโดย http://localhost:8080/jw/web/json/workflow/process/list

api response ของคุณควรจะเป็น:

{"packageId":"CRM","name":"new package 1 work process 1","id":"CRM#1#newpkg1_wp1","packageName":"CRM","label":"newpkg1 wp1 ver 1","version":"1"}

Start a Process

Thai

เริ่มกระบวนการ

By using JSON API /json/workflow/process/start/(*:processDefId)

Thai

โดยใช้ JSON API /json/workflow/process/start/(*:processDefId)

Info
titleMethod Call

Please note that one must use POST to make such particular JSON API call.

Thai

โปรดทราบว่าต้องใช้ POST เพื่อทำการเรียก JSON API เฉพาะ

Sample Call:

Thai

ตัวอย่างการเรียก:

Code Block
/web/json/workflow/process/start/CRM:1:newpkg1_wp1?j_username=admin&j_password=admin

Sample Result:

Thai

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

Code Block
{"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1","processId":"2117_CRM_newpkg1_wp1"}

NOTE: workflow variables can be set when starting a process by passing additional parameters into the URL, e.g., var_ticketId=123456&var_relatedTo=network.

Thai

หมายเหตุ: ตัวแปรเวิร์กโฟลว์สามารถตั้งค่าได้เมื่อเริ่มต้นกระบวนการโดยส่งพารามิเตอร์เพิ่มเติมไปยัง URL เช่น var_ticketId=123456&var_relatedTo=network

Complete the Assignment with Variables

Thai

ทำการกำหนดค่าให้เสร็จสมบูรณ์ด้วยตัวแปร

By using JSON API /json/workflow/assignment/completeWithVariable/(*:activityId)

Thai

โดยใช้ JSON API /json/workflow/assignment/completeWithVariable/(*:activityId)

Info
titleMethod Call

Please note that one must use POST to make such particular JSON API call.

Thai

โปรดทราบว่าต้องใช้ POST เพื่อทำการเรียก JSON API เฉพาะ

Sample Call:

Thai

ตัวอย่างการเรียก:

Code Block
/web/json/workflow/assignment/completeWithVariable/2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1?var_ticketId=123456&var_relatedTo=network&j_username=admin&j_password=admin

Sample Result:

Thai

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

Code Block
{"activityId":"2122_2117_CRM_newpkg1_wp1_newpkg1_wp1_act1","assignment":"org.joget.workflow.model.WorkflowAssignment@1b99f74","processId":"2117_CRM_newpkg1_wp1","status":"completed"}

Abort a Process

Thai

ยกเลิกกระบวนการ

By using JSON API /json/workflow/process/abort/(*:processId)

Thai

โดยใช้ JSON API /json/workflow/process/abort/(*:processId)

Info
titleMethod Call

Please note that one must use POST to make such particular JSON API call.

Thai

โปรดทราบว่าต้องใช้ POST เพื่อทำการเรียก JSON API เฉพาะ

Sample Call:

Thai

ตัวอย่างการเรียก:

Code Block
/web/json/workflow/process/abort/2117_CRM_newpkg1_wp1?j_username=admin&j_password=admin

Sample Result:

Thai

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

Code Block
{"id":"2117_CRM_newpkg1_wp1","status":"aborted"}


Frequency problems

  1. When first calling API or experiment in developer environment (localhost), you should check settings that already config appropriate API Domain Whitelist and API IP Whitelist. If you want to experiment by accept calling from any domain, ip address then you can input it as *

  • Please be careful on security concern if you are setting API Domain Whitelist and API IP Whitelist as * in production environment


Thai

ปัญหาที่พบบ่อย

  1. เมื่อจะเรียก API ครั้งแรกหรือทดสอบพัฒนาในเครื่องตนเอง (localhost) ควรตรวจสอบดู settings ว่ามีการตั้งค่า API Domain Whitelist และ API IP Whitelist ที่เหมาะสมไว้แล้วหรือไม่ หากต้องการทดสอบโดยให้รับการเรียกจากทุกๆ Domain, IP Address สามารถใส่ * ได้ 

*ข้อควรระวังว่าอาจทำให้เกิดความไม่ปลอดภัยหากใช้ setting นี้เป็น * ใน production environment