Cancel Work Item

API Type

REST

HTTP Method

POST

Description

Cancels a manual work item based on a specified manual work item identifier. Only the following manual work item status can transition to a Canceled status: Assigned, New, Pseudo, and Overdue.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/CancelWorkItem/[workItemID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/CancelWorkItem/[workItemID]

Request Parameters

Name	Description
workItemID	Definition: An ID that represents a work item (task). Type string Allowed Values: A valid, unique 32-byte work item (task) ID.

Request Body Properties

Name	Description
clientData	Definition: Specifies the client data, which identifies a client for AgilePoint Server. Type string Allowed Values: A string that contains the client data. If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.

JavaScript Code Example

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

  var JSONObject = { clientData: null };

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                CancelWorkItem/BBD9BF28AA4C43AC956636E9288F3E6E",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String CancelWorkItem(String workItemID, String clientData) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/CancelWorkItem/"
                       + workItemID;

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("clientData", clientData);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string CancelWorkItem()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         CancelWorkItem/E48644178C514A95AB457F00A35F1550";

    string jsonRequestData = "{\"clientData\":\"" + null + "\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

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

Supported Versions

AgilePoint BPMS v5.0 R2 and higher