Delete Process Instance

API Type

REST

HTTP Method

POST

Description

Deletes a process instance. This method removes the specified process instance and all the associated data from the database, such as work items, email, and activity instances associated with this process instance. It may take some time to complete this transaction.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/DeleteProcInst/[processInstanceID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/DeleteProcInst/[processInstanceID]

Request Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID

JavaScript Code Example

$("#btnDeleteProcInst").click(function () {

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                DeleteProcInst/248685A175F54C12A9A80353798B4508",
  });

});

Java Code Example

public String DeleteProcessInstance(String processInstanceID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/DeleteProcInst/"
                       + processInstanceID;

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  JSONObject postData = new JSONObject();

  return ops.POSTMethod(URI, postData.toString());
}

C# Code Example

public string DeleteProcId()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         DeleteProcInst/577BDA85E1A94F6084D73037FC91D4A8";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URI, "");
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher