Cancel Process Instance

API Type

REST

HTTP Method

POST

Description

Cancels the process instance based on a specified Create Process Instance.

Good to Know

This method cancels all system activities, human tasks, and child process instances.
To call this method, the API account user must have the access right, Cancel a Process.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

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

JavaScript Code Example

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

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

});

Java Code Example

public String CancelProcInst() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        CancelProcInst/248685A175F54C12A9A80353798B4508";

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

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

C# Code Example

public string CancelProcInst()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         CancelProcInst/248685A175F54C12A9A80353798B4508";

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

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

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.

curl --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         -X POST -d 
                         '{"PROCESSINSTANCEID":"{827028D244B4F4D9117757491D0C4F53}"}'
                         https://mydomain:9011/AgilePointServer/Workflow/
                         CancelProcInst/827028D244B4F4D9117757491D0C4F53

Output

WFEvent object that provides the status of the transaction. The possible statuses are:

Sent - Indicates event has been sent to engine for processing.
Failed - Indicates event failed to process.
Processed - Indicates event has been processed successfully.
Canceled - Indicates event was canceled.
Deferred - Indicates event does not need to be sent immediately.

JSON Response Body Example

{
  "ActivityInstID": "",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": "\/Date(928149600000+0000)\/",
  "Entries": 1,
  "Error": null,
  "EventID": "B501460A104444C487DEE1B16DD1A7CF",
  "EventName": "CancelProcessInstance",
  "HighPriority": true,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ProcInstID\" 
                          value=\"355E739A362A46D5B987AEF3951DF9F5\" \/>
                  <param name=\"HighPriority\" value=\"True\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "355E739A362A46D5B987AEF3951DF9F5",
  "ProcInstName": "",
  "Sender": "mydomain\\administrator",
  "SentDate": "\/Date(1394137494815+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",
  "UserID": "",
  "WorkItemID": "",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.