Process Runtime REST API
Process REST API is the list of REST APIs which is used to navigate the process flow from start to finish and to communicate with each other node over the process flow. The transfer of data happens over the network, which communicates through HTTP/HTTPS protocols.
The below table show the list of REST API methods provided to control process flow. For more details please check the API Guide
Request
Description
HTTP Method
1. /BPMREST/service/runtime/process/start
To start the flow.
POST
2. /BPMREST/service/runtime/process/[Process Name]/start
Old API to start flow. It is not recommended.
POST
3. /BPMREST/service/runtime/tasks/[Task ID]/claim?user=[User Name]
To claim a task by user.
POST
4. /BPMREST/service/runtime/tasks/[Task ID]/complete?user=[User Name]
To complete a process by user.
POST
5. /BPMREST/service/runtime/instance/[Instance ID]/tasks
To get task by instance ID.
GET
6. /BPMREST/service/runtime/tasks?[group/role/user]=[User Name/Role Name/Group Name]
To get task by user or role or group name
GET
7. /BPMREST/service/runtime/tasks/[Task ID]/variables
To get Task variables
POST
8. /BPMREST/service/runtime/tasks/[Task ID]/assign?user=[User Name]&user=[User Name1]..&user=[User Name n]
To assign task to user/ users
POST
9. /BPMREST/service/runtime/instance/[Instance ID]/tasks/assign?user=[User Name]
To assign instance to user
POST
10. /BPMREST/service/runtime/refreshCache
To refresh cache for all process
POST
11. /BPMREST/service/runtime/classAction
To refresh cache for a specific process
POST
Last updated