Create Pseudo Work Item

API Type

REST

HTTP Method

POST

Description

Creates a task by a specific AgileWork or other module that has the following characteristics:

It does not have to be completed in order for a process to advance to the next steps.
Unless specifically canceled, it remains active through the duration of the entire process, not just the duration of the AgileWork or other module that created it.

This provides a way for tasks to be included in a user's or manager's task list purely for monitoring purposes.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
bReserved	Definition: Reserved for future use. Type bool Allowed Values: A null value
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 CreatePseudoWorkItemHelper

JavaScript Code Example

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

  var JSONObject = { 
        SourceWorkItemID: "2AA1E203047B41F29E3E29F62D00903B",
        WorkToPerform: "Test1234", 
        UserID: "demo3\\brian.lucas",
        Length: "2",
        Unit: "DAY",
        BusinessTime:true,
        bReserved: true,
        ClientData: null
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/CreatePseudoWorkItem",
    data: JSON.stringify(JSONObject)
  });
  }
});

Java Code Example

public String CreatePseudoWorkItem(String SourceWorkItemID,
  String WorkToPerform, String UserID, String Length, String Unit,
  boolean BusinessTime, boolean bReserved, boolean ClientData) {

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

  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", bReserved);
    postData.put("ClientData", ClientData);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string btnCreatePseudoWorkItem()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Workflow/CreatePseudoWorkItem";

    string jsonRequestData = "{
      \"SourceWorkItemID\":\"E48644178C514A95AB457F00A35F1550\",
      \"WorkToPerform\":\"Test1234\",
      \"UserID\":\"ap2\\administrator\",
      \"Length\":\"2\",
      \"Unit\":\"DAY\",
      \"BusinessTime\":\"true\",
      \"bReserved\":\"true\",
      \"ClientData\":\"" + null + "\"}";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

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\\brian.lucas\" \/>
                  <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\\brian.lucas",
  "SentDate": "\/Date(1394148475011+0000)\/",
  "SourceWorkItemID": "2AA1E203047B41F29E3E29F62D00903B",
  "Status": "Sent",
  "UserID": "demo3\\brian.lucas",
  "WorkItemID": "CE4265BC8CA944F885446962D0463974",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher