Assign Work Item (Extended Method)

API Type

Web Services

Description

Assigns a work item to a user, which often means claiming a work item for oneself. This is often used with task pools where work items are created, and then multiple users are notified, but the work item is not immediately assigned to a user. A user then claims the work item, or his manager assigns it to him. The user must have privileges to claim or assign the work item. This method extends AssignWorkItem() by allowing you to specify client data.

Syntax

public virtual WFEvent AssignWorkItemEx(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 representing the workflow event instance raised by the invocation of the work assignment.

Example

IWFWorkflowService svc = GetWorkflowService();
string workItemID = …// work item ID
string clientData = null;

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

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

Supported Versions

3.2.0.4 and higher