Update Work Item

API Type

Web Services

Description

Updates the properties for a human task (manual work item) or a system activity (automatic work item).

Good to Know

  • Lets you update only the properties: Task Name, Original User ID, ClientData, Pool ID, Pool Info, Status, User ID, Resolve Participant, Priority, or Due Date.

    If you try to update any other property, it throws an exception.

  • To call this method, the API account user must have the access right, Create a Task.

Syntax

public virtual void UpdateWorkItem(string workItemID, NameValue[] attributes)

Parameters

NameDescription

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

attributes
Description:
A NameValue array that contains the attributes that needs to be updated in the work item.
Type
NameValue
Allowed Values:

For a manual work item, the following attributes can be updated:

  • NAME
  • ORIGINAL_USER_ID
  • CLIENT_DATA, POOL_ID
  • POOL_INFO
  • STATUS
  • USER_ID
  • PRIORITY
  • DUE_DATE

For an automatic work item, the following attributes can be updated:

  • DUE_DATE
  • STATUS - if the value is Canceled, Completed, Overdue, Running, or Waiting.

Output

None.

Example

IWFWorkflowService svc = GetWorkflowService();
string workItemID = …// work item ID of manual work item or automatic work item.

try
	{
    NameValue[] attributes = NameValue.Array( 
    "NAME", "[New Name]",
    "DUE_DATE", [DateTime]); // for example, DateTime.Now.AddDays(3.0)
    svc.UpdateWorkItem(workItemID, attributes);
	}

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

Supported Versions

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