Delete Process Definition

API Type

REST

HTTP Method

POST

Description

Deletes the process definition and all of the process instances associated with the process definition. The process definition cannot be deleted if one or more process instances associated with the process definition is running or suspended. The function may take a long time to execute if there are many process instances associated with the process definition.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/DeleteProcDef/[processTemplateID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/DeleteProcDef/[processTemplateID]

Request Parameters

Name	Description
processTemplateID	Definition: The unique identifier for the process definition to be checked out for modification. Type string Allowed Values: A valid process template ID

JavaScript Code Example

$("#btnDeleteProcDef").click(function () {
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                  DeleteProcDef/C769BA234EFD421B8B95A525B972E511"
  });
});

Java Code Example

public String DeleteProcDef(String processTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/DeleteProcDef/"
                       + processTemplateID;

  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 DeleteProcDef()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         DeleteProcDef/3B9A54192B6C4C4AA902BD46279C7FAF";

    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