Online Process REST API

Online Process REST API

The Online Process REST api allow to get information about the online processes and related workflows stored in the online database.

API Methods

Get processes

To retrieve all the processes make an HTTP GET request : http://<server>:<port>/online-service/process

The response of type application/json is an array of Json objects, each object contain information about a process and the related workflows.

It is possible to specify query parameters to filter the results.

The following parameters are available:

• name: retrieve only the processes with the specified name

• owner: retrieve only the processes with the specified owner

• date: retrieve only the processes with the specified date in ISO format (YYYY-MM-DDThh:mm:ss.SSS±hh:mm)

• creationDate: retrieve only the processes with the specified creation date in ISO format (YYYY-MM-DDThh:mm:ss.SSS±hh:mm)

• basecase: retrieve only the processes with the specified basecase

Note that the parameters values must be URL escaped.

Example: http://<server>:<port>/online-service/process?name=proc1234,user=operator2,basecase=2016-10-27T00%3A00%3A00.000%2B01%3A00,date=2016-10-27T00%3A00%3A00.000%2B01%3A00,creationDate=2016-10-27T00%3A00%3A00.000%2B01%3A00

The method will return a "HTTP 400 Bad request" error if one of the specified parameters has wrong format (i.e. wrong date format).

Get process by processId

To retrieve a single process identified by a processId make an http GET request : http://<server>:<port>/online-service/process/{processId}

The response of type application/json is a Json objecs that contains information about the specified process and the related workflows.

The method will return a "HTTP 404 Not found" error if the specified processId does not exists.

Get workflow by processId and workflowId

To retrieve a single workflow identified by a processId and a workflowId make an http GET request : http://<server>:<port>/online-service/process/{processId}/{workflowId}

The response of type application/json is a Json objects that contains information about the specified workflow.

The method will return a "HTTP 404 Not found" error if the specified processId or workflowId does not exists.