...
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 พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / กระบวนการ / เริ่มต้น / CRM: 3: กระบวนการ 1 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"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
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / กระบวนการ / ตัวแปร / 208_crm_process1 / สถานะ value = ทดสอบ ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"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 พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / กระบวนการ / view / CRM: 3: กระบวนการ 1 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "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 พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ขั้นตอนการทำงาน / ตัวแปร / รายการ / 208_crm_process1 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{
| ||
Code Block | ||
| ||
{
"processId": "208_crm_process1",
"variable": {
"status": "approved"
}
} |
...
http://localhost:8080/jw/web/json/monitoring/activity/abort/208_crm_process1/send_proposal
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ตรวจสอบ / กิจกรรม / ยกเลิก / 208_crm_process1 / send_proposal ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"activityDefId":"send_proposal","status":"aborted","processId":"208_crm_process1"} |
...
http://localhost:8080/jw/web/json/monitoring/activity/list?processId=116_hr_expense_process1
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ตรวจสอบ / กิจกรรม / รายการ ProcessID = 116_hr_expense_process1 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{
"total": 3,
"data": [{
" | ||
Code Block | ||
| ||
{
"total": 3,
"data": [{
"id": "474_116_hr_expense_process1_approve_claim",
"serviceLevelMonitor": "-",
"name": "Approve Claim",
"state": "open.not_running.not_started",
"dateCreated": "15-07-2015 02:54 AM"
}, {
"id": "472_116_hr_expense_process1_new_claim",
"serviceLevelMonitor": "-",
"name": "Edit Claim",
"state": "closed.completed",
"dateCreated": "15-07-2015 02:53 AM"
}, {
"id": "473_116_hr_expense_process1_tool4",
"serviceLevelMonitor": "-",
"name": "Update Record Status to Submitted",
"state": "closed.completed",
"dateCreated": "15-07-2015 02:54 AM"
}]
} |
...
http://localhost:8080/jw/web/json/monitoring/activity/reassign?activityId=841_206_crm_process1_send_proposal&username=admin&replaceUser=cat
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http: // localhost: 8080 / เจดับบลิว / เว็บ / JSON / ตรวจสอบ / กิจกรรม / มอบหมาย ActivityId = 841_206_crm_process1_send_proposal & username = ผู้ดูแลระบบและ replaceUser = แมว ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"activityId":"841_206_crm_process1_send_proposal","username":"admin","replaceUser":"cat"} |
...
http://localhost:8080/jw/web/json/monitoring/activity/reevaluate?activityId=841_206_crm_process1_send_proposal
...
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/activity/reevaluate?activityId=841_206_crm_process1_send_proposal |
web/json/monitoring/activity/start/(*:processId)/(*:activityDefId)
...
http://localhost:8080/jw/web/json/monitoring/activity/start/116_hr_expense_process1/verify_claim
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/activity/start/116_hr_expense_process1/verify_claim ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"result":true,"activityDefId":"verify_claim","processId":"116_hr_expense_process1"} |
...
http://localhost:8080/jw/web/json/monitoring/activity/variable/474_116_hr_expense_process1_approve_claim/status?value=test
Sample Result
Code Blockthai | ||
---|---|---|
ลักษณะ | js | |
{"status":"variableSet"} |
web/json/monitoring/activity/view/(*:activityId)
Description
Retrieves information of an activity instance
User Role
Admin
Method
HTTP GET/POST
...
ตั้งค่าให้กับตัวแปรเวิร์กโฟลว์เป็นอินสแตนซ์ของกิจกรรมที่ดำเนินอยู่ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/activity/variable/474_116_hr_expense_process1_approve_claim/status?value=test ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"status":"variableSet"} |
web/json/monitoring/activity/view/(*:activityId)
Description
Retrieves information of an activity instance
User Role
Admin
Method
HTTP GET/POST
Parameters
- callback - (Optional) Optional) a function (in JavaScript) to call back after invoking this method
- activityId - activity instance id
...
http://localhost:8080/jw/web/json/monitoring/activity/view/474_116_hr_expense_process1_approve_claim
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/activity/view/474_116_hr_expense_process1_approve_claim ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "processId": "116_hr_expense_process1", "serviceLevelMonitor": "-", "createdTime": "Wed Jul 15 10:54:10 MYT 2015", "processName": "Expense Approval Process", "assignee": "admin", "activityId": "474_116_hr_expense_process1_approve_claim", "activityDefId": "approve_claim", "processVersion": "1", "processDefId": "hr_expense#1#process1", "participant": "approver", "finishTime": "", "variable": { "status": "test" }, "activityName": "Approve Claim", "dueDate": "" } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- packageId - (Optional) App/ package id
- processId - (Optional) process instance id for filtering
- processName - (Optional) process name for filtering
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- filtering
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/monitoring/completed/process/list?rows=3 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 74, "data": [{ "id": "133_hr_expense_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Expense Approval Process", "state": "closed.aborted", "due": "-", "startedTime": "29-07-2015 01:46 AM", "version": "2" }, { "id": "135_crm_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Proposal Approval Process", "state": "closed.aborted", "due": "-", "startedTime": "04-08-2015 09:28 AM", "version": "2" }, { "id": "136_crm_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Proposal Approval Process", "state": "closed.aborted", "due": "-", "startedTime": "04-08-2015 09:31 AM", "version": "2" }] } |
web/json/monitoring/process/copy/(*:processId)/(*:processDefId)
Description
Copies the state and workflow variables of a running process instance to start a new process instance
User Role
Admin
Method
HTTP POST
Parameters
...
*:processDefId)
Description
Copies the state and workflow variables of a running process instance to start a new process instance
User Role
Admin
Method
HTTP POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- processId - process instance id
- processDefId - process definition id to start a new process (replace "#" to ":")
- abortCurrent - (Optional) true or false value to abort the current running process instance after start a new process instance
Sample URL
http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
|
...
|
...
|
...
URL http://localhost:8080/jw/web/json/monitoring/process/copy/116_hr_expense_process1/hr_expense:1:process1 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "processId": "228_hr_expense_process1", "processDefId": "hr_expense#1#process1", "activities": [ "896_228_hr_expense_process1_approve_claim" ] } |
web/json/monitoring/process/variable/(*:processId)/(*:variable)
Description
Sets a value to 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 instance id
- variable - workflow variable name
- value - workflow variable value
...
variable)
Description
Sets a value to 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 instance id
- variable - workflow variable name
- value - workflow variable value
Sample URL
http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/process/variable/224_crm_process1/status?value=test |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"status":"variableSet"} |
...
http://localhost:8080/jw/web/json/monitoring/process/view/224_crm_process1
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/process/view/224_crm_process1 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "requester": "admin", "serviceLevelMonitor": "-", "processId": "224_crm_process1", "name": "Proposal Approval Process", "finishTime": "", "states": ["open.running", "open.running"], "packageId": "crm", "processDefId": "crm#3#process1", "dueDate": "", "startedTime": "", "version": "3" } |
web/json/monitoring/running/activity/complete
Description
Completes a running activity
User Role
Admin
Method
HTTP POST
Parameters
- processDefId - process definition id (replace "#" to ":")
- processId - process instance id
- activityId - activity instance id
Sample URL
http://localhost:8080/jw/web/json/monitoring/running/activity/complete
...
?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี |
Description
Completes a running activity
User Role
Admin
...
HTTP POST |
...
พารามิเตอร์ |
...
|
...
|
...
|
...
|
...
|
...
|
...
http://localhost:8080/jw/web/json/monitoring/running/activity/complete?processDefId=crm:3:process1&processId=224_crm_process1&activityId=885_224_crm_process1_approve_proposal |
web/json/monitoring/running/activity/reassign
Description
Reassigns a user to replace another user assigned to an assignment
User Role
AdminMethod
Method
HTTP POST
Parameters
- processDefId - process definition id (replace "#" to ":")
- processId - process instance id
- activityId - activity instance id
- username - username that will replace the assigned user
- replaceUser - username of an existing assignee of the assignment
Sample URL
http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST |
...
พารามิเตอร์ |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
URL http://localhost:8080/jw/web/json/monitoring/running/activity/reassign?processDefId=crm:3:process1&processId=227_crm_process1&activityId=890_227_crm_process1_approve_proposal&username=cat&replaceUser=admin |
web/json/monitoring/running/process/list
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- packageId - (Optional) app/package id
- processId - (Optional) process instance id
- processName - (Optional) process name
- version - (Optional) process version
sort - (Optional) column name to be sorteddesc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descendingOptional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/monitoring/running/process/list?packageId=crm&rows=3 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 16, "data": [{ "id": "118_crm_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Proposal Approval Process", "state": "open.running", "due": "-", "startedTime": "21-07-2015 03:03 AM", "version": "1" }, { "id": "119_crm_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Proposal Approval Process", "state": "open.running", "due": "-", "startedTime": "21-07-2015 03:03 AM", "version": "1" }, { "id": "120_crm_process1", "serviceLevelMonitor": "-", "requesterId": "admin", "name": "Proposal Approval Process", "state": "open.running", "due": "-", "startedTime": "21-07-2015 03:03 AM", "version": "1" }] } |
...
http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP POST พารามิเตอร์
http://localhost:8080/jw/web/json/monitoring/user/reevaluate?username=cat |
SLA
web/json/workflow/activity/sla/list
Description
Retrieve first process with details of every packages
User Role
Admin
Method
HTTP GET/POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- appId - (Optional) app defintion id
- appVersion - (Optional) app definition version
- processDefId - (Optional) process definition id without package id and version
Sample URL
http://localhost:8080/jw/web/json/workflow/activity/sla/list?appId=crm
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST |
...
พารามิเตอร์
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
URL http://localhost:8080/jw/web/json/workflow/activity/sla/list?appId=crm |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3, "data": [{ "ratioOnTime": 100, "activityDefId": "approval", "serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>", "minDelay": 0, "ratioWithDelay": 0, "maxDelay": 0, "activityName": "Approval" }, { "ratioOnTime": 100, "activityDefId": "parallel", "serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>", "minDelay": 0, "ratioWithDelay": 0, "maxDelay": 0, "activityName": "Parallel" }, { "ratioOnTime": 100, "activityDefId": "route1", "serviceLevelMonitor": "<span class=\"dot_green\"> <\/span>", "minDelay": 0, "ratioWithDelay": 0, "maxDelay": 0, "activityName": "Route 1" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- dateFrom - (Optional) date start for filtering. Format is filtering. Format is yyyy-MM-dd
- dateTo - (Optional) date to for filtering. Format is yyyy-MM-dd
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/workflow/audittrail/list?rows=5
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
|
...
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/workflow/audittrail/list?rows=5 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3225, "data": [{ "timestamp": "25-06-2015 07:41 AM", "message": "Authentication for user admin: true", "id": "2c90a1574e29523a014e29aa77590000", "username": "anonymousUser", "method": "authenticate", "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider" }, { "timestamp": "25-06-2015 08:41 AM", "message": "Authentication for user admin: true", "id": "2c90a1574e29e104014e29e178080000", "username": "anonymousUser", "method": "authenticate", "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider" }, { "timestamp": "25-06-2015 08:55 AM", "message": "testProcess", "id": "2c90a1574e29e81c014e29eddb7a0000", "username": "admin", "method": "processUpload", "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl" }, { "timestamp": "25-06-2015 08:55 AM", "message": "50_testProcess_process1", "id": "2c90a1574e29e81c014e29eddecf0001", "username": "anonymousUser", "method": "processCompleted", "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl" }, { "timestamp": "25-06-2015 08:55 AM", "message": "50_testProcess_process1", "id": "2c90a1574e29e81c014e29edded80002", "username": "anonymousUser", "method": "processCompleted", "clazz": "org.joget.workflow.model.service.WorkflowManagerImpl" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- orgId - (Optional) orgnization id
sort - (Optional) column name to be sortedto be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/dept/list
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/dept/list |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 7, "data": [{ "id": "D-001", "description": "", "name": "CEO Office", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-002", "description": "", "name": "Human Resource and Admin", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-003", "description": "", "name": "Finance", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-004", "description": "", "name": "Marketing", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-005", "description": "", "name": "Product Development", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-006", "description": "", "name": "Training and Consulting", "organization.name": "Joget.Org", "parent.name": "" }, { "id": "D-007", "description": "", "name": "Support and Services", "organization.name": "Joget.Org", "parent.name": "" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this methodname - (Optional) name filter
- name - (Optional) name filter
- orgId - (Optional) organization id
- deptId - (Optional) department id
- gradeId - (Optional) grade 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
Sample URL
http://localhost:8080/jw/web/json/directory/admin/employment/list?name=j
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/employment/list?name=j |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 2, "data": [{ "grade.name": "Managers", "user.firstName": "Jack", "user.id": "jack", "role": null, "user.lastName": "Drake", "organization.name": "Joget.Org", "employeeCode": null, "user.username": "jack", "department.name": "Training and Consulting" }, { "grade.name": "Executives", "user.firstName": "Julia", "user.id": "julia", "role": null, "user.lastName": "Kapatelis", "organization.name": "Joget.Org", "employeeCode": null, "user.username": "julia", "department.name": "Human Resource and Admin" }] } |
...
- 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
...
- name - (Optional) name filter
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/employment/noHaveOrganization/list
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/employment/noHaveOrganization/list |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 1, "data": { "user.firstName": "Admin", "user.id": "admin", "role": "", "user.lastName": "", "employeeCode": "", "user.username": "admin" } } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
sort - (Optional) column name to be sorted) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/employment/noInDept/list?orgId=ORG-001&deptId=D-003&name=j
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/employment/noInDept/list?orgId=ORG-001&deptId=D-003&name=j |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3, "data": [{ "grade.name": "Executives", "user.firstName": "Cat", "user.id": "cat", "role": "", "user.lastName": "Grant", "employeeCode": "", "user.username": "cat", "department.name": "Product Development" }, { "grade.name": "Managers", "user.firstName": "Jack", "user.id": "jack", "role": null, "user.lastName": "Drake", "employeeCode": null, "user.username": "jack", "department.name": "Training and Consulting" }, { "grade.name": "Executives", "user.firstName": "Julia", "user.id": "julia", "role": null, "user.lastName": "Kapatelis", "employeeCode": null, "user.username": "julia", "department.name": "Human Resource and Admin" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- orgId - Organization id
- gradeId - Grade 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
Sample URL
http://localhost:8080/jw/web/json/directory/admin/employment/noInGrade/list?orgId=ORG-001&gradeId=G-003&name=c
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/employment/noInGrade/list?orgId=ORG-001&gradeId=G-003&name=c |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3, "data": [{ "grade.name": "Managers", "user.firstName": "Clark", "user.id": "clark", "role": null, "user.lastName": "Kent", "employeeCode": null, "user.username": "clark", "department.name": "Product Development" }, { "grade.name": "Managers", "user.firstName": "Jack", "user.id": "jack", "role": null, "user.lastName": "Drake", "employeeCode": null, "user.username": "jack", "department.name": "Training and Consulting" }, { "grade.name": "Managers", "user.firstName": "David", "user.id": "david", "role": null, "user.lastName": "Cain", "employeeCode": null, "user.username": "david", "department.name": "Support and Services" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- orgId - (Optional) organization id for 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
...
- name - (Optional) name filter
- orgId - (Optional) organization id for filter
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/group/list
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/group/list |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3, "data": [{ "id": "G-001", "description": "", "name": "Managers", "organization.name": "" }, { "id": "G-002", "description": "", "name": "CxO", "organization.name": "" }, { "id": "G-003", "description": "", "name": "hrAdmin", "organization.name": "" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- orgId - (Optional) Organization Id for 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
...
- name - (Optional) name filter
- orgId - (Optional) Organization Id for filter
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/grade/list
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/grade/list |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 3, "data": [{ "id": "G-001", "description": "", "name": "Board Members" }, { "id": "G-002", "description": "", "name": "Managers" }, { "id": "G-003", "description": "", "name": "Executives" }] } |
web/json/directory/admin/organization/list
Description
Retrieves all organizations
User Role
Admin
...
/list
Description
Retrieves all organizations
User Role
Admin
Method
HTTP GET/POST
Parameters
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/organization/list
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST |
...
พารามิเตอร์
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/organization/list |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 1, "data": { "id": "ORG-001", "description": "", "name": "Joget.Org" } } |
...
http://localhost:8080/jw/web/json/directory/admin/subdept/list?deptId=D-001
Sample ResultResult
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/subdept/list?deptId=D-001 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 1, "data": { "id": "sub", "description": "", "name": "Sub Department" } } |
...
http://localhost:8080/jw/web/json/directory/admin/user/deptAndGrade/options?orgId=ORG-001
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
http://localhost:8080/jw/web/json/directory/admin/user/deptAndGrade/options?orgId=ORG-001 ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "departments": [{ "id": "", "name": "", "prefix": "" }, { "id": "D-001", "prefix": "", "name": "CEO Office" }, { "id": "D-003", "prefix": "", "name": "Finance" }, { "id": "D-002", "prefix": "", "name": "Human Resource and Admin" }, { "id": "D-004", "prefix": "", "name": "Marketing" }, { "id": "D-005", "prefix": "", "name": "Product Development" }, { "id": "D-007", "prefix": "", "name": "Support and Services" }, { "id": "D-006", "prefix": "", "name": "Training and Consulting" }], "grades": [{ "id": "", "name": "", "prefix": "" }, { "id": "G-001", "name": "Board Members" }, { "id": "G-003", "name": "Executives" }, { "id": "G-002", "name": "Managers" }] } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- userId - Username that a user is in or not in the group
- orgId - (Optional)
- inGroup - (Optional) true or false. default to true
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
...
) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/user/group/list?userId=admin
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/user/group/list?userId=admin |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 1, "data": { "id": "G-001", "description": "", "name": "Managers", "organization.name": "" } } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- orgId - (Optional) Organization id for filter
- deptId - (Optional) Department id for filter
- gradeId - (Optional) Grade id for filter
- groupId - (Optional) Group id for filter
- roleId - (Optional) Role id for filter
- active - (Optional) 1 = active, 0 = not active
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
...
- - (Optional) Role id for filter
- active - (Optional) 1 = active, 0 = not active
sort - (Optional) column name to be sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/user/list?groupId=G-002
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
ตัวอย่าง URL http://localhost:8080/jw/web/json/directory/admin/user/list?groupId=G-002 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 1, "data": { "id": "terry", "lastName": "Berg", "username": "terry", "email": "", "active": "Active", "firstName": "Terry" } } |
...
- callback - (Optional) a function (in JavaScript) to call back after invoking this method
- name - (Optional) name filter
- groupId - Group id for filter
sort - (Optional) column name to be sortedbe sorted
desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
start - (Optional) where rows start from
rows - (Optional) number of rows per page
Sample URL
http://localhost:8080/jw/web/json/directory/admin/user/notInGroup/list?groupId=G-002
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์ callback - (เป็นตัวเลือก) ฟังก์ชั่น (ใน JavaScript) เพื่อโทรกลับหลังจากเรียกใช้วิธีนี้ desc - ( |
...
เป็นตัวเลือก) ค่าบูลีนเพื่อพิจารณาว่าจะเรียงตามลำดับจากน้อยไปมากหรือจากมากไปน้อย (จริงเท่ากับจากมากไปหาน้อย) start - ( |
...
เป็นทางเลือก) โดยที่แถวเริ่มต้น rows - ( |
...
เป็นทางเลือก) จำนวนแถวต่อหน้า ตัวอย่าง |
...
URL http://localhost:8080/jw/web/json/directory/admin/user/notInGroup/list?groupId=G-002 |
...
ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{ "total": 4, "data": [{ "id": "admin", "lastName": "", "username": "admin", "email": "", "firstName": "Admin" }, { "id": "cat", "lastName": "Grant", "username": "cat", "email": "owen@joget.org", "firstName": "Cat" }, { "id": "clark", "lastName": "Kent", "username": "clark", "email": "", "firstName": "Clark" }, { "id": "david", "lastName": "Cain", "username": "david", "email": "", "firstName": "David" }] } |
...
http://localhost:8080/jw/web/json/directory/user/sso?j_username=admin&j_password=admin
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ไม่ระบุชื่อ วิธี HTTP GET / POST สนับสนุนการตรวจสอบสิทธิ์พื้นฐาน HTTP พารามิเตอร์
http://localhost:8080/jw/web/json/directory/user/sso?j_username=admin&j_password=admin ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"username":"admin","isAdmin":"true", "token": "OWASP_CSRFTOKEN=7BKT-GL1V-Y5LR-T3JJ-41W2-JRBL-CCDB-7C03"} |
...
http://localhost:8080/jw/web/json/workflow/currentUsername
Sample Result
Thai |
---|
ลักษณะ บทบาทของผู้ใช้ ผู้ดูแลระบบ วิธี HTTP GET / POST พารามิเตอร์
http://localhost:8080/jw/web/json/workflow/currentUsername ตัวอย่างผลลัพธ์ |
Code Block | ||
---|---|---|
| ||
{"username":"admin"} |
...