Cancel Activity Instance

API Type

REST

HTTP Method

POST

Description

Cancels a manual activity instance along with all manual work items associated with the specified manual activity instance ID. Note that an activity instance can be associated with one or more manual work items. Once the manual activity instance is canceled, the process instance will move forward to the next activity.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/CancelActivityInst/[activityInstanceID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/CancelActivityInst/[activityInstanceID]

Request Parameters

JavaScript Code Example

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

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                CancelActivityInst/3E14D9BE837C47F2BA17A724508AC8CD",
  });

});

Java Code Example

public String CancelActivityInst(String activityInstanceID,
  String FromUser, Calendar StartDate) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/CancelActivityInst/"
                       + activityInstanceID;

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("FromUser", FromUser);
    postData.put("StartDate", "\\/Date(" + StartDate.getTimeInMillis()
      + "+0000)\\/");
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string CancelActivityInst()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         CancelActivityInst/3E14D9BE837C47F2BA17A724508AC8CD";

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

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

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": "0F6B47906A0C4B469AC9CB9A7F2FF831",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": "\/Date(928149600000+0000)\/",
  "Entries": 1,
  "Error": null,
  "EventID": "D77D30744057465DACE447B35D609597",
  "EventName": "CancelActivityInstance",
  "HighPriority": true,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ProcInstID\" 
                            value=\"00131C75A35046A89E32B64C4649E075\" \/>
                  <param name=\"ActivityInstID\" 
                          value=\"0F6B47906A0C4B469AC9CB9A7F2FF831\" \/>
                  <param name=\"HighPriority\" value=\"True\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "00131C75A35046A89E32B64C4649E075",
  "ProcInstName": "",
  "Sender": "demo3\\administrator",
  "SentDate": "\/Date(1394145752063+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",	
  "UserID": "",
  "WorkItemID": "",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher