Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

where <method-name> represents the name of a java method of the org.pentaho.common.ui.metadata.service.MetadataService class.

Methods

For an up-to-date overview of the available methods, refer to the source. At the time of writing, these methods are known:

  • listBusinessModels - Returns a list of the available business models ( in XML )format. 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 in JSON format. Parameters:
    • domainName - optional domain to limit the results
    • context - Area to check for model visibility
  • loadModel - Returns a model object for the requested model in XML format. The model will include the basic metadata: categories and columns.
    • domainId - the internal id of the domain. You can retrieve this using the listBusinessModels and listBusinessModelsJson service calls
    • modelId - the internal id of the model. You can retrieve this using the listBusinessModels and listBusinessModelsJson service calls
  • loadModelJson - Returns a model object for the requested model in JSON format. The model will include the basic metadata: categories and columns.
    • domainId - the internal id of the domain. You can retrieve this using the listBusinessModels and listBusinessModelsJson service calls
    • modelId - the internal id of the model. You can retrieve this using the listBusinessModels and listBusinessModelsJson service calls
  • doQuery - Executes a query model and returns a serializable result set.
    • Query
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doXmlQuery - Executes a XML query and returns a serializable result set
    • Query (in MQL XML Vocabulary)
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doXmlQueryToJson
  • doXmlQueryToCdaJson
  • doJsonQuery
  • doJsonQueryToJson
  • doJsonQueryToCdaJson

...