Assign Work Item

API Type

Web Services

Description

Assigns a human task (manual work item) to a user, which often means claiming a task for oneself.

Good to Know

  • This is often used with task pools where tasks are created, and then multiple users are notified, but the task is not immediately assigned to a user. A user then claims the task, or his manager assigns it to him.
  • The user must have access rights to claim or assign the task.

Syntax

public virtual WFEvent AssignWorkItem(string workItemID)

Parameters

NameDescription

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 class that represents the workflow event instance that is created when the task is assigned.

Example

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

try
    {
    WFEvent evt = svc.AssignWorkItem(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.