Get Work Item

API Type

REST

HTTP Method

GET

Description

Retrieves the manual work item object for a specified ID.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetWorkItem/[workItemID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetWorkItem/[workItemID]

Request Parameters

Name	Description
workItemID	Definition: An ID that represents a work item (task). Type string Allowed Values: A valid, unique 32-byte work item (task) ID.

JavaScript Code Example

$("#btnGetWorkItem").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetWorkItem/00634B57AC4A4DAA90DFB998D889A820",
    type: "GET"
  });
  
});

Java Code Example

public String GetWorkItem(String workItemID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetWorkItem/"
                       + workItemID;

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

  return ops.GETMethod(URI);
}

C# Code Example

 public string GetWorkItem()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetWorkItem/E48644178C514A95AB457F00A35F1550";

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

    return ops.GetData(URI);
  }

Output

WFMaunalWorkItem object.

JSON Response Body Example

{
  "GetWorkItemResult": 
  {
    "ActivatedDate": "\/Date(1394147363103+0000)\/",
    "ActivityInstID": "0DB05C1A1BAB445895CCF46E096AECDD",
    "ApplName": "MyApplication",
    "AssignedDate": "\/Date(1390001063537+0000)\/",
    "BeingProcessed": false,
    "CancelledDate": "\/Date(1394147189803+0000)\/",
    "ClientData": "",
    "CompletedDate": “\/Date(928149600000+0000)\/”,
    "CreatedDate": "\/Date(1390001063537+0000)\/",
    "DefName": "BudgetRequestProcess",
    "DisplayName": "Revise",
    "DueDate": "\/Date(1390087440000+0000)\/",
    "DueHandled": true,
    "LastModifiedBy": "demo3\\administrator",
    "LastModifiedDate": "\/Date(1394147363107+0000)\/",
    "Name": "Revise",
    "OriginalUserID": "demo3\\administrator",
    "Pending": false,
    "PoolID": "",
    "PoolInfo": "",
    "Priority": "Normal",
    "ProcDefID": "258220E3849F4D04853F7B591B9C385E",
    "ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
    "ProcInstName": "BudgetRequestProcess-B7F0ACFA610349B4BF10A4DAB8E93458",
    "ResolveParticipant": "",
    "RestrictionType": "  ",
    "Session": 1,
    "SourceWorkItemID": "",
    "Status": "Cancelled",
    "UserID": "demo3\\administrator",
    "WaitWorkPerformed": true,
    "WorkItemID": "2AA1E203047B41F29E3E29F62D00903B",
    "WorkObjectID": "4B7A98C9374C4480A26D06DC67379FE3"
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher