Get Work List By User ID

API Type

REST

HTTP Method

POST

Description

Retrieves a work item collection by specifying a user name and work item status.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Status	Definition: The status of the work item. Type string Allowed Values: New - The work item is in a pool, more than one participant shares the work item and needs to be assigned. Assigned - The work item is assigned to a participant and needs to be performed. Removed - The work item was originally in a pool (status is new), and didn't get assigned to the user. Completed - The work item is completed. Reassigned - The work item is re-assigned to the other user. Canceled - The work item is canceled. Overdue - The work item is overdue. Carbon - The work item is a carbon copy that does not affect process instance running.
UserName	Definition: Specifies a qualified user name of the instance. A qualified user name formats as [Domain Name]\[Logon Username] or [Local host name]\[Logon Username]. Type string Allowed Values: A valid user name for a registered AgilePoint user.

Name

Description

Status

Definition:

The status of the work item.

Type

string

Allowed Values:

New - The work item is in a pool, more than one participant shares the work item and needs to be assigned.
Assigned - The work item is assigned to a participant and needs to be performed.
Removed - The work item was originally in a pool (status is new), and didn't get assigned to the user.
Completed - The work item is completed.
Reassigned - The work item is re-assigned to the other user.
Canceled - The work item is canceled.
Overdue - The work item is overdue.
Carbon - The work item is a carbon copy that does not affect process instance running.

UserName

Definition:: Specifies a qualified user name of the instance. A qualified user name formats as [Domain Name]\[Logon Username] or [Local host name]\[Logon Username].
Type: string
Allowed Values:: A valid user name for a registered AgilePoint user.

These properties are based on the class GetWorkListByUserIDHelper

JavaScript Code Example

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

  var JSONObject = {
    UserName: "demo3\\brian.lucas", 
    Status: "Completed"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/GetWorkListByUserID",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String GetWorkListByUserID(String UserName, String Status) {

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

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("UserName", UserName);
    postData.put("Status", Status);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

Output

Array of WFManualWorkItem objects.

JSON Response Body Example

[{
  "ActivatedDate": "\/Date(928149600000+0000)\/",
  "ActivityInstID": "064046C009DC4F5583509D8189F3B771",
  "ApplName": "MyApplication",
  "AssignedDate": "\/Date(1389318661983+0000)\/",
  "BeingProcessed": false,
  "CancelledDate": "\/Date(1389319005427+0000)\/",
  "ClientData": "",
  "CompletedDate": "\/Date(928149600000+0000)\/",
  "CreatedDate": "\/Date(1389318661983+0000)\/",
  "DefName": "BudgetRequestProcess",
  "DisplayName": "Manager Approval",
  "DueDate": "\/Date(1389405060000+0000)\/",
  "DueHandled": false,
  "LastModifiedBy": "demo3\\brian.lucas",
  "LastModifiedDate": "\/Date(1389319005427+0000)\/",
  "Name": "ManagerApprove",
  "OriginalUserID": "demo3\\brian.lucas",
  "Pending": false,
  "PoolID": "",
  "PoolInfo": "",
  "Priority": "Normal",
  "ProcDefID": "258220E3849F4D04853F7B591B9C385E",
  "ProcInstID": "B49C9AA65BE1470884A9F1DF60632ABC",
  "ProcInstName": "BudgetRequestProcess-B49C9AA65BE1470884A9F1DF60632ABC",
  "ResolveParticipant": "",
  "RestrictionType": "  ",
  "Session": 1,
  "SourceWorkItemID": "",
  "Status": "Reassigned",
  "UserID": "demo3\\brian.lucas",
  "WaitWorkPerformed": true,
  "WorkItemID": "485194FC741F4A4E83A71CDCBD9997D3",
  "WorkObjectID": "D6DF81165A744F1A803169051615E37C"
}]

Supported Versions

AgilePoint BPMS v5.0 R2 and higher