Get Database Information

API Type

REST

HTTP Method

GET

Description

Retrieves the database information of the current server configuration.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

$("#btnGetDatabaseInfo").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetDatabaseInfo",
    type: "GET"
  });
  
});

Java Code Example

public String GetDatabaseInformation() {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

A DatabaseInfo object that represents the database information of the system.

JSON Response Body Example

{
  "GetDatabaseInfoResult": 
  {
    "Connstr": "application name= Mycompany Server;
                connection lifetime=5;
                min pool size=10;
                server=DMEO3;
                database=APDB50R2;
                trusted_Connection=yes"
    "Provider": null
    "Vendor": "MSSQLDatabase"
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher