Query Procedure List

API Type

REST

HTTP Method

POST

Description

Retrieves a list of automatic work items that match a specified query expression.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
expr	Definition: Specifies the where clause of a SQL query expression. Type WFQueryExprHelper Allowed Values: A valid WFQueryExpr object.
ColumnName	Definition: Gets and sets the associated database column name. Type string Allowed Values: A valid database column name.
Operator	Definition: Specifies the operator used for comparison. Type int Allowed Values: A valid operator.
WhereClause	Definition: Sets the conditions against a query. Type string Allowed Values: A valid SQL WHERE clause.
IsValue	Definition: Gets and sets the flag that indicates if it compares a value or column of the table. Type bool Allowed Values: True - It compares a value or column of the table. False - It does not compare a value or column of the table.

JavaScript Code Example

$("#btnQueryProcedureList").click(function () {
  
  var JSONObject = {
    ColumnName: "SYNCHRONOUS", Operator: "EQ", WhereClause: "No", IsValue: true
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/QueryProcedureList",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String QueryProcedureList(String ColumnName, String Operator,
  String WhereClause, boolean IsValue) {

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

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("ColumnName", ColumnName);
    postData.put("Operator", Operator);
    postData.put("WhereClause", WhereClause);
    postData.put("IsValue", IsValue);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
	}

C# Code Example

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

    string jsonRequestData="{
      \"ColumnName\":\"" + "SYNCHRONOUS" + "\",
      \"Operator\":\"" +"EQ"+ "\",
      \"WhereClause\":\"" +"No"+ "\",
      \"IsValue\":\"" +"true"+ "\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

Output

An array of automatic work items.

JSON Response Body Example

[{
  "ActivityInstID": "F002ECAF07764DE5B0ADE53D4FB7C2F4",
  "ApplName": "MyApplication",
  "CompletedDate": "\/Date(928149600000+0000)\/",
  "CreatedDate": "\/Date(1390771702547+0000)\/",
  "DueDate": "\/Date(1390771732547+0000)\/",
  "DueHandled": false,
  "Pending": false,
  "ProcInstID": "0E05B456F489468D90414A7E9AF8CDF3",
  "ProcedureInfo": "#AgilePart:Ascentn.AgilePart.Process, 
                     Version=1.0.0.0, Culture=neutral, 
                     PublicKeyToken=2973ddf2dfd2d294:Ascentn.Workflow.Extension.ProcessManagementAgilePart:Delay",
  "Session": 32,
  "Status": "Cancelled",
  "Synchronous": false,
  "WorkItemID": "0078B6ECE50A47B3A3907341DF8F8B5E"
}]

Supported Versions

AgilePoint BPMS v5.0 R2 and higher