Create Linked Work Item

API Type

REST

HTTP Method

POST

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.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/CreateLinkedWorkItem

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/CreateLinkedWorkItem

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
bDependent	Definition: Specifies whether the target work item waits for a linked work item to be completed or canceled before moving forward. Type bool Allowed Values: True - The source work item waits until the linked work item is either completed or canceled, before it can be completed or canceled. False - The source work item can be completed or canceled regardless of whether the linked work item is completed or canceled.
BusinessTime	Definition: Determines whether the system calculates the duration using your business time calendar. Type bool Allowed Values: True - The system calculates duration using business time. False - The calculates the duration based on real time.
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.
Length	Definition: Specifies the length of time duration. Type string Allowed Values: A valid time duration length.
SourceWorkItemID	Definition: An ID that represents the original, or source, work item. Type string Allowed Values: A valid, unique 32-character ID.
Unit	Definition: Specifies the unit. Type string Allowed Values: A valid unit.
UserID	Definition: Specifies the user ID. Type string Allowed Values: A valid user ID.
WorkToPerform	Definition: Represents the task that performed by the participants of the activity. Type string Allowed Values: A valid work to perform name.

These properties are based on the class CreateLinkedWorkItemHelper

JavaScript Code Example

$("#btnCreateLinkedWorkItem").click(function () {

  var JSONObject = { 
    SourceWorkItemID: "0E11FFE63E594128B662CD27A259E4B3",
                   WorkToPerform: "Test123", 
                   UserID: "demo3\\susan.miller",
                   Length: "2",
                   Unit: "DAY",
                   BusinessTime:true,
                   bDependent: true,
                   ClientData: null
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/CreateLinkedWorkItem",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String CreateLinkedWorkItem(String SourceWorkItemID,
  String WorkToPerform, String UserID, String Length, String Unit,
  boolean BusinessTime, boolean bDependent, String ClientData) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/CreateLinkedWorkItem";

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  JSONObject postData = new JSONObject();
  try {
    postData.put("SourceWorkItemID", SourceWorkItemID);
    postData.put("WorkToPerform", WorkToPerform);
    postData.put("UserID", UserID);
    postData.put("Length", Length);
    postData.put("Unit", Unit);
    postData.put("BusinessTime", BusinessTime);
    postData.put("bDependent", bDependent);
    postData.put("ClientData", ClientData);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

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.

JSON Response Body Example

{
  "ActivityInstID": "0DB05C1A1BAB445895CCF46E096AECDD",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": “\/Date(928149600000+0000)\/”,
  "Entries": 1,
  "Error": null,
  "EventID": "572215CBEA884B7890259879C21FAC42",
  "EventName": "CreateWorkItem",
  "HighPriority": true,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ExpectedTime\" value=\"2 Day(s)(business time)\" \/>
                  <param name=\"workPerformer\" value=\"Revise\" \/>
                  <param name=\"SourceWorkItemID\" 
                            value=\"2AA1E203047B41F29E3E29F62D00903B\" \/>
                  <param name=\"ProcInstID\" 
                            value=\"B7F0ACFA610349B4BF10A4DAB8E93458\" \/>
                  <param name=\"UserID\" value=\"demo3\\administrator\" \/>
                  <param name=\"ActivityInstID\" 
                            value=\"0DB05C1A1BAB445895CCF46E096AECDD\" \/>
                  <param name=\"waitWorkPerformed\" value=\"True\" \/>
                  <param name=\"HighPriority\" value=\"True\" \/>
                  <param name=\"Carbon\" value=\"False\" \/>
                  <param name=\"WorkItemID\" 
                            value=\"CE4265BC8CA944F885446962D0463974\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
  "ProcInstName": "",
  "Sender": "demo3\\administrator",
  "SentDate": "\/Date(1394148475011+0000)\/",
  "SourceWorkItemID": "2AA1E203047B41F29E3E29F62D00903B",
  "Status": "Sent",	
  "UserID": "demo3\\administrator",
  "WorkItemID": "CE4265BC8CA944F885446962D0463974",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher