Information Technology Reference
In-Depth Information
REST interface
The simplest way to communicate with the KIE Workbench is through the REST interface.
A group of REST service classes expose a series of URLs to access different runtime en-
gines inside the KIE Workbench. The following table shows some of the URLs:
URL
Functionality
/rest/runtime/{deployment-id}/process/
{process-id}/start
This URL allows you to start a process instance. Here, the parameters are passed
through the body.
/rest/runtime/{deployment-id}/process/
instance/{process-instance-id}/abort
This URL allows you to send the abort signal to a running process instance.
/rest/runtime/{deployment-id}/process/
instance/{process-instance-id}/signal/
{signal-ref}
This URL allows you to send a specific signal to a running process instance.
/rest/runtime/{deployment-id}/signal/
{signal-id}
This URL sends a signal to the whole KIE session instead of just one process in-
stance.
/rest/runtime/{deployment-id}/workitem/
{workitem-id}/complete
This URL allows the user to complete a work item remotely. Here, the parameters
are sent through the body.
/rest/runtime/{deployment-id}/workitem/
{workitem-id}/abort
This URL allows the user to abort a work item remotely.
This URL allows the user to execute a command sent through the post body.
/rest/runtime/{deployment-id}/execute
/rest/runtime/{deployment-id}/process/
instance/{process-instance-id}/variable/
{var-name}
This URL retrieves the value of a variable for a specific process instance.
/rest/runtime/{deployment-id}/process/
instance/{process-instance-id}
This URL retrieves a specific process instance.
This URL allows you to perform multiple different operations on top of the task
service (claim, activate, complete, and so on). Here, the parameters are sent
through the post body.
/rest/task/{task-id}/{operation}
This URL allows you to perform queries on top of the task service database.
/rest/task/query
