Create Work Item

API Type

Web Services

Description

Creates a human task (manual work item) for the specified activity instance ID.

Good to Know

  • You must send the activity instance ID, WorkToPerform, user ID, task owner, duration, and ClientData (optional) parameters for this API call.
  • To call this method, the API account user must have the access right, Create a Task.
  • The created task is not dependent on any other tasks.

Syntax

public virtual WFEvent CreateWorkItem(string ActivityInstanceID, string WorkToPerform, string UserID, WFTimeDuration Length, string ClientData)

Parameters

Name Description

ActivityInstanceID
Function:
The unique ID for an activity instance.
Type
string
Accepted Values:
A valid activity instance ID.

WorkToPerform
Function:
Represents the task that performed by the participants of the activity.
Type
string
Accepted Values:
A valid work to perform name.

UserID
Function:
Specifies the user associated with the work item.
Type
string
Accepted Values:
A valid user ID.

Length
Function:
Specifies the length of time duration.
Type
string
Accepted Values:
A valid time duration length.

ClientData
Function:
Specifies the client data, which identifies a client for AgilePoint Server.
Type
string
Accepted 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

IWFWorkflowService svc = GetWorkflowService();
string ActivityInstanceID = … // for example, "0172460E0AF943C6A6520044452BCAB3";
string WorkToPerform = … // for example, "SubmitRequest";
//different WorkToPerform can be used if desired

WFTimeDuration Length = new WFTimeDuration("15", WFTimeUnit.DAY, true );// business time
string UserID = @"[DOMAIN NAME]\username"; //the participant of the linked work item

try
	{
    WFEventevt = svc.CreateWorkItem(ActivityInstanceID,
    WorkToPerform, UserID, Length, null);
	}

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.