CDA API

CDA API Reference ..

Understanding the API allows you to leverage CDA (Community Data Access) to integrate data with external applications. This capability is particularly valuable when you're not using CDE (Community Dashboard Editor) or CDF (Community Dashboard Framework) for dashboard development.

The API integration with CTools provides enhanced functionality through CDA's Web API interface. To make requests, use this base URL structure:

$BASE_URL/$WEBAPP/plugin/cda/api/

Where:

• $BASE_URL represents the protocol, hostname, and port

• $WEBAPP is the Apache Tomcat web application name (default is 'pentaho')

Here's a sample URL demonstrating a query to the pentaho webapp:

http://localhost:8080/pentaho/plugin/cda/api/doQuery?dataAccessId=top50Customers&path=/public/CTools-Dashboard/CDA/sampledata-queries.cdalocalhost

---

APIs

getCdaList

The getCdaList endpoint will get a list of all the CDA files available inside the repository. There is no need to specify the parameters for this endpoint.

http://localhost:8080/pentaho/plugin/cda/api/getCdaListlocalhost

listQueries

listParameters

doQuery

previewQuery

editFile