Get Database Information

API Type

REST

HTTP Method

GET

Description

Retrieves the database information of the current server configuration.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

JavaScript Code Example

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

Java Code Example

public String GetDatabaseInfo() {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

cURL Code Example

curl -H "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         https://mydomain:9011/AgilePointServer/Admin/GetDatabaseInfo

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 v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

• AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
• Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
• Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.