/rest/api/process

Service to start and resume processes.

DELETE v1/instances/{instanceId}

Deletes the process instance defined by the given id.

Response
application/json; charset=UTF-8

ProcessResultContainerDTO - The result of a process execution.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
instanceId
The id of the process instance.
false
 

POST v1/instances/{instanceId}

Resumes the process instance defined by the given id.

Response
application/json; charset=UTF-8

ProcessResultContainerDTO - The result of a process execution.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
ProcessParameterDTO  
instanceParameter
The parameter passed into the process.
false
 
PATH
String  
instanceId
The id of the process instance.
false
 

POST v1/processes/deployments

Deploys the head revision of all processes with the given process id.

Response
application/json; charset=UTF-8

ProcessInfoDTO - The process container.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
QUERY
List
String
processIds
The pks of the processes to be deployed
false
 

POST v1/processes/{processId}

Starts the process identified by the given id and passes the parameter.

Response
application/json; charset=UTF-8

ProcessResultContainerDTO - The result of a process execution.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
FORM
ProcessParameterDTO  
processParameter
The parameter passed to the process.
false
 
PATH
String  
processId
The id of the process.
false
 

GET v1/processes/{processId}

Returns the head revision of the process with the given id. The result provides e.g. deployment information.

Response
application/json; charset=UTF-8

ProcessInfoDTO - The process container.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
processId
The id of the process.
false
 

DELETE v1/processes/{processId}/deployments

Removes the deployment of the process with the given process id.

Response
application/json; charset=UTF-8

ProcessInfoDTO - The process container.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
processId
The id of the process.
false
 

POST v1/processes/{processId}/deployments

Deploys the head revision of the process with the given process id.

Response
application/json; charset=UTF-8

ProcessInfoDTO - The process container.

Request
application/json; charset=UTF-8

Parameter Type
Type
Name
Description
Optional
Default Value
PATH
String  
processId
The id of the process.
false