The Pentaho BI server ships a lightweight general purpose webservice for accessing metadata. This is implemented as a webservice plugin by the org.pentaho.common.ui.metadata.service.MetadataService class. This forms a more generic and independent API as compared to to the (unmaintained) WAQR metadata services.
The common ui metadata service is part of the common ui plugin. It can be accessed via You can find this in pentaho-solutions/system/common-ui. Here's a snippet from the common-ui plugin.xml that defines the metadata service:
| Code Block |
|---|
<webservice
id="metadataService"
type="xml,gwt"
/>
|
Service API / Urls
The Common UI Metadata service can be accessed both as an ordinary webservice and as a GWT webservice.
XML Webservice API
All Common UI Metadata services are accessed using urls of this form:
http://localhost:8080/pentaho/content/ws-run/metadataService/<method-name>
The method name represents where <method-name> represents the name of a java method of the org.pentaho.common.ui.metadata.service.MetadataService class. Valid For an up-to-date overview of the methods, refer to the source. At the time of writing, these methods are :
...
known:
- listBusinessModels - Returns a list of the available business models (XML). Parameters:
- domainName - optional domain to limit the results
- context - Area to check for model visibility
- listBusinessModelsJson - Returns a JSON list of the available business models
- loadModel
- loadModelJson
- doQuery
- doXmlQuery
- doXmlQueryToJson
- doXmlQueryToCdaJson
- doJsonQuery
- doJsonQueryToJson
- doJsonQueryToCdaJson
GWT Webservice API
This document does not describe the GWT style of the API. (Community, feel free to add this documentation).