Query Database

API Type

Web Services

Description

Queries the database with a valid SQL query and returns the dataset as a string in the XML format.

Good to Know

If trustedAuthorization is set to False, this method will not execute unless a special access control is turned on.
For more information, refer to Why Do I Get an Access Denied Error for an API Method Call?.

Syntax

public virtual string QueryDatabase(string sql)

Parameters

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

Output

An XML string that contains the dataset with the results of the database query.

Example

IWFWorkflowService svc = GetWorkflowService();
string sql = "SELECT * FROM WF_AUDIT_TRAILS where CATEGORY = 0 AND
PURPOSE='Check-in process definition'";

try
	{
    // calling the QueryDatabase web method and passing the sql query as the argument.
    string xml = svc.QueryDatabase(sql);
    Console.WriteLine("{0}", xml);// Displaying the XML string on console.
    System.IO.stringReader sr = new System.IO.stringBuilder(xml);
    System.Data.DataSet ds = new System.Data.DataSet();
    ds.LoadXml(sr);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 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.