Cancel Work Item

API Type

Web Services

Description

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

Good to Know

Only the following task status can transition to a Cancelled status: Assigned, New, Pseudo, and Overdue.
To call this method, the API account user must have the access right, Cancel a Task.
It is not possible to cancel a task that has child tasks running.

Syntax

public virtual WFEvent CancelWorkItem(string workItemID)

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.

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.

Example

IWFWorkflowService svc = GetWorkflowService();
string workItemID = … //

try
	{
    WFEvent evt = svc.CancelWorkItem(workItemID);
	}

catch( Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 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.