Create Linked Work Item

API Type

Web Services

Description

Creates a manual work item that is linked to another manual work item. The work item you create does not depend on the completion of the work item to which it is linked. In other words, the original (source) work item can be marked as completed before new work item is completed.

Syntax

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

Parameters

Name Description

SourceWorkItemID

Definition:
An ID that represents the original, or source, work item.
Type
string
Allowed Values:
A valid, unique 32-character ID.

WorkToPerform

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

UserID

Definition:
Specifies the user ID.
Type
string
Allowed Values:
A valid user ID.

duration

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

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

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