Get Procedure

API Type

REST

HTTP Method

GET

Description

Retrieves work item data by a specified work item ID.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetProcedure/[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

$("#btnGetProcedure").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetProcedure/0000274B0AA64BBC8FCA086A6EFDFA44",
    type: "GET"
  });
  
});

Java Code Example

public String GetProcedure(String workItemID) {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcedure()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetProcedure/27BDCAFF90954753B0F8FA8F864EA79C";

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

    return ops.GetData(URI);
  }

Output

WFAutomaticWorkItem object.

JSON Response Body Example

{
  "GetProcedureResult": 
  {
    "ActivityInstID": "6909C1D0B5D44F10AE1EDB9393A6DA21",
    "ApplName": "MyApplication",
    "CompletedDate": "\/Date(1380915210920+0000)\/",
    "CreatedDate": "\/Date(1380915200837+0000)\/",
    "DueDate": "\/Date(1380915780000+0000)\/",
    "DueHandled": false,
    "Pending": false,
    "ProcInstID": "E94493C9E919466898344A056CB7619E",
    "ProcedureInfo": "#AgilePart:XmlOperationsAP, Version=1.0.0.0, 
                       Culture=neutral, 
                       PublicKeyToken=d9ba5adf10cbd939:XmlOperationsAP.XmlOperations:XmlOperationsMethod",
    "Session": 1,
    "Status": "Completed",
    "Synchronous": true,
    "WorkItemID": "0008FD6D6F354EB39281C1EE95E76CCC"
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher