Cancel Activity Instance

HTTP Method

POST

Description

Cancels an activity instance for the specified activity instance ID.

Good to Know

• Changes the status of an activity to Cancelled.
• An activity instance can be associated with one or more work items.
• Once the activity instance is cancelled, the process instance will move forward to the next activity.
• The process instance must be in the running status, or an exception is thrown.
• This API cancels all the tasks from multiple sessions of this activity if the tasks are in Assigned or Overdue status.
• To call this method, the API account user must have the access right, Cancel a Task.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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 URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        CancelActivityInst/3E14D9BE837C47F2BA17A724508AC8CD";
          
  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);
          
  JSONObject postData = new JSONObject();          
          
  return ops.POSTMethod(URI, postData.toString());
}

C# Code Example

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

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

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

cURL Code Example

curl --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         -X POST -d '{"ACTIVITYINSTANCEID":"{827028D244B4F4D9117757491D0C4F59}"}' 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         CancelActivityInst/827028D244B4F4D9117757491D0C4F59

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": "mydomain\\administrator",
  "SentDate": "\/Date(1394145752063+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",	
  "UserID": "",
  "WorkItemID": "",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint v5.0 R2 and higher