B Appendix B: Process Flow REST Endpoints

The table in this appendix provides a description of the REST resources.

Table B-1 REST Resource Descriptions

REST Resource	HTTP Method	Description
/discover	GET	Lists all available endpoints
/batch/processes/enable-disable	POST	Enable or disable process flows
/batch/processes/operator/{processName}	POST	Start a new Process Flow execution
/batch/processes/executions/{processName}	GET	List Process Executions for the process name
/batch/processes/executions	GET	List all process execution IDs
/batch/processes/executions/status/{status}	GET	List all process execution IDs for the specified status
/batch/processes/executions/time/{startTime}/{endTime}	GET	List all process execution IDs for the specified time range
/batch/processes/external-variables	GET	List external variables
/batch/processes/external-variables	PUT	Create external variables
/batch/processes/external-variables	POST	Update external variables
/batch/processes/external-variables/{key}	DELETE	Delete external variable
/batch/processes/currently-running-processes	GET	List all the currently running process flows
/batch/processes	GET	Get all the available process definitions
/batch/processes/{processName}	GET	Get process DSL for the specified process
/batch/processes/executions/{processName}/{processExecutionId}/activities/{activityExecutionId}	GET	Get Activity execution detail for the activity specified
/batch/processes/executions/{processName}/{processExecutionId}	GET	Get all the activities for the process flow execution
/batch/processes/{processName}/activities	GET	Get all the activities for the process specified
/batch/processes/operator/{processName}/{processExecutionId}	POST	Restart a process execution instance
/batch/processes/operator/{processName}/resolve	POST	Sets the status of process to PROCESS_FAILED
/batch/processes/{processName}/{processExecutionId}	DELETE	Stops running process
/batch/processes/executions	DELETE	Stops all running processes
/telemetry/processes	GET	Returns process runtime metrics between fromTime and toTime