DELETE Process API

Delete Process API is used to delete one or more non-executing Processes from the Connect:Direct processing queue. The delete process command can also delete an executing Process when the option force=yes is set.

Note: One of the four parameters 'processName, processNumber, submitter, secondaryNode' is mandatory.
Method URI

DELETE

cdwebconsole/svc/processcontrolcriterias

The following example shows the Command:
curl -X 'DELETE' \
           'https://172.20.183.89:9443/cdwebconsole/svc/processcontrolcriterias' \
           -H 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJhZG1pbmlzdHJhdG9yOjE3Mi4yMC4xODYuMjAzOjEzNjM6MTU0NzRkOGItYTRjZC00ZDVjLTg5NzMtZTIzYTZiYjA1YmM5IiwiZXhwIjoxNzE1MDAwNTE0fQ.028GAKiMpFaauKYkd7VDA1iC-IbcHgD_OWsuO_A0RLARyiQizOrHKhGBsttmadmiwUUE4OsL9VOddOC3MCj8uQ' \
           -H 'Content-Type: application/json' \
           -H 'X-XSRF-TOKEN: f124e232-0cdd-4a61-b882-63c1a45c8df8' \
           -d '{"processName":"TF25","processNumber":"","secondaryNode":"","submitter":"","hold":"","force":""}'   
Table 1. Input Parameters
Parameter Name Required/Optional Description Valid values
processName

Optional

Specifies the Process name. May be a single Process name, or a list separated by commas

 
processNumber Optional Specifies the Process number. May be a single Process number, or a list separated by commas  
secondaryNode Optional Specifies the secondary node of the records desired. If a list is specified, the list must be enclosed in parentheses  
submitter Optional Specifies the node and userid of the submitter in the form of node,userId or a list of node and userid separated by semicolon  
hold Optional Specifies the new hold specification yes, no, call
force Optional If yes is specified, the Process identified is to be deleted even if it is running yes, no
The following example shows the Sample Request:
{
 "processName": "TF12",
 "processNumber": "",
 "secondaryNode": "",
 "submitter": "",
 "hold": "",
 "force": ""
}
The following example shows the Sample Response:
[
  {
    "messageCode": 200,
    "message": "The process has been successfully deleted"
  }
]