Get Work List By User ID

API Type

REST

HTTP Method

POST

Description

Retrieves a human task (manual work item) collection by specifying a user name and task status.

Good to Know

  • Multiple status can be specified with a semicolon (;) delimited list.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

Status
Function:
The status of the work item.
Type
string
Accepted 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
Function:
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
Accepted 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: "mydomain\\brian.lucas", 
    Status: "Completed"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/GetWorkListByUserID",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String GetWorkListByUserID() {

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

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

  JSONObject postData = new JSONObject();
  
    postData.put("UserName", "mydomain\\brian.lucas");
    postData.put("Status", "Completed");
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string GetWorkListByUserID()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/GetWorkListByUserID";

    string jsonRequestData = "{
      \"userName\":\"" + "mydomain\\\\brian.lucas" + "\",
      \"Status\":\"" + "Completed" + "\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"UserName\":\"mydomain\\brian.lucas\",
                         \"Status\":\"Completed\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/GetWorkListByUserID

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": "mydomain\\brian.lucas",
  "LastModifiedDate": "\/Date(1389319005427+0000)\/",
  "Name": "ManagerApprove",
  "OriginalUserID": "mydomain\\brian.lucas",
  "Pending": false,
  "PoolID": "",
  "PoolInfo": "",
  "Priority": "Normal",
  "ProcDefID": "258220E3849F4D04853F7B591B9C385E",
  "ProcInstID": "B49C9AA65BE1470884A9F1DF60632ABC",
  "ProcInstName": "BudgetRequestProcess-B49C9AA65BE1470884A9F1DF60632ABC",
  "ResolveParticipant": "",
  "RestrictionType": "  ",
  "Session": 1,
  "SourceWorkItemID": "",
  "Status": "Reassigned",
  "UserID": "mydomain\\brian.lucas",
  "WaitWorkPerformed": true,
  "WorkItemID": "485194FC741F4A4E83A71CDCBD9997D3",
  "WorkObjectID": "D6DF81165A744F1A803169051615E37C"
}]

Supported Versions

AgilePoint v5.0 R2 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.