Create Linked Work Item

API Type

Web Services

Description

Creates a human task (manual work item) that is linked to another human task.

Good to Know

  • The task you create may or may not depend on the completion of the task to which it is linked. It is based on the input parameter for the API -- for example Dependent with a value of true or false. In other words, if Dependent is set to true, the parent task cannot be completed until the newly created task gets completed. If Dependent is set to false the parent task can be marked as Completed before new task is completed.
  • To call this method, the API account user must have the access right, Create a Task.

Syntax

public virtual WFEvent CreateLinkedWorkItem(string SourceWorkItemID, string WorkToPerform, string UserID, WFTimeDuration duration, string ClientData)

Parameters

Name Description

SourceWorkItemID
Function:
An ID that represents the original, or source, work item.
Type
string
Accepted Values:
A valid, unique 32-character 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 ID.
Type
string
Accepted Values:
A valid user ID.

duration
Function:
Specifies the duration settings of a work item.
Type
WFTimeDuration
Accepted Values:
A valid WFTimeDuration object.

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

None.

Example

IWFWorkflowService svc = base.GetWorkflowService();
// get existing work item
string workItemID = ..// for example,
"90CF843AC57644058A391FBFA030F607"

try
	{
    // Get the source WFManualWorkItem object
    WFManualWorkItem SourceWorkItemID = svc.GetWorkItem(workItemID)
    string WorkToPerform = SourceWorkItemID.Name; //different
    WorkToPerform can be used if desired
    WFTimeDuration duration = new WFTimeDuration();
    duration.Length = "15"; //for example, 15 days
    duration.Unit = WFTimeUnit.DAY;
    string UserID = @"[DOMAIN NAME]\username"; //the participant of the
    linked work item
    WFEvent evt = svc.CreateLinkedWorkItem(
             SourceWorkItemID.WorkItemID,
             WorkToPerform,
             UserID,
             duration,
             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.