Try OpenEdge Now
skip to main content
Configuration
Configuring Batch Programs : API references : DELETE( ) method (Process)
 

DELETE( ) method (Process)

DELETE /containers/{container}/batch/{key}/processes/{processid}
Removes the tracking of the specified Batch Program process and stops the process before removing it.
Note: Stopping the process before removing the process is optional.
The Shutdown method to stop the process can be either Terminate or Shutdown script. If this method stops the process before removing it, the process is no longer tracked. If this method is not specified, the tracking of the process is removed without stopping the process.

Endpoint URL

/containers/{container}/batch/{key}/processes/{processid}
*{container} refers to the name of the AdminServer on which the Batch Program process is running.
*{key} refers to the OpenEdge Management resource key for the Batch program process.
*{processid} refers to the Process ID assigned for tracking the Batch program process through the REST API.

HTTP method

DELETE

Parameters

This method uses stop as a parameter in the endpoint URL.
/containers/{container}/batch/{key}/processes/{processid}?stop=true
Parameter
Data type
Optional
Description
stop
boolean
Yes
Indicates if the process must be stopped before removing it. The default is set to false.
If the shutdown of the process fails, the process tracking is not removed.

Sample request

None

Sample response

None