Query Register Users Using SQL

API Type

REST

HTTP Method

POST

Description

Query the list of registered users in AgilePoint.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/QueryRegisterUsersUsingSQL

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/QueryRegisterUsersUsingSQL

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
sqlWhereClause	Definition: The where clause of the SQL statement you want to query. Type string Allowed Values: The where clause of a SQL statement.

JavaScript Code Example

$("#btnQueryRegisterUsersUsingSQL").click(function () {
  
  var JSONObject = { sqlWhereClause: "WF_REG_USERS.MANAGER='demo3\\susan.miller'" };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/QueryRegisterUsersUsingSQL",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String QueryRegisterUsersUsingSQL(String sqlWhereClause) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/QueryRegisterUsersUsingSQL";

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("sqlWhereClause", sqlWhereClause);

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

C# Code Example

public string QueryRegisterUsersUsingSQL(string RegisteredUser)
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/QueryRegisterUsersUsingSQL";

    string jsonRequestData = "{\"sqlWhereClause\":\""+RegisteredUser+"\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

Output

An array of registered users.

JSON Response Body Example

[{
  "Department": "Administrator"
  "EmailAddress": "admin@mycompany.com"
  "FullName": "administrator"
  "Locale": "en-US"
  "Manager": "demo3\susan.miller"
  "OnlineContact": "admin@mycompany.com"
  "RefID": ""
  "RegisteredDate": "\/Date(928149600000)\/"
  "TimeZone": ""
  "Title": ""
  "UALExpirationDate": " \/Date(928149600000)\/"
  "UALNeverExpires": false
  "UserName": "demo3\administrator"
}]

Supported Versions

AgilePoint BPMS v5.0 R2 and higher