Cancel Work Item (Task)

API Type

REST

HTTP Method

POST

Description

Cancels a human task (manual work item) based on a specified task ID.

Good to Know

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description

workItemID

Function:
An ID that represents a work item (task).
Type
string
Accepted Values:
A valid, unique 32-byte work item (task) ID.

Request Body Properties

Name Description

clientData

Function:
Specifies the client data, which identifies a client for AgilePoint Server.
Type
string
Accepted 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 URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        CancelWorkItem/BBD9BF28AA4C43AC956636E9288F3E6E";

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

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

C# Code Example

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

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

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

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 "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST --data {\"clientData\":\"\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         CancelWorkItem/827128D244B4F4D91177614E52349CF9

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

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the API Documentation

The AgilePoint NX API documentation is intended as a basic reference to help you understand how to make API calls. API 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.