Undo Assign Work Item (Extended Method)

API Type

Web Services

Description

Unassigns a work item that was previously assigned to a user. This method applies to work items that can be assigned to members of task groups, where a work item can be assigned to or claimed by any of a group of users. The extended method includes client data.

Syntax

public virtual WFEvent UndoAssignWorkItemEx(string workItemID, string clientData)

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.

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.

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

string url = "http://[hostname]:[port]/AgilePointServer";           
string workItemID = …// for example,
"03ABD59A0EB74D7A8741709478E83877";
string clientData = …///

try
	{
    WFEvent evt = svc.UndoAssignWorkItemEx(workItemID, clientData);
	}

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

Supported Versions

3.2.0.4 and higher