Versions Compared

Key

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

...

  • 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 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 (in MQL Vocabulary) and returns a serializable result set
    • Xml Query (in MQL Vocabulary)
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doXmlQueryToJson - Executes a XML query (in MQL Vocabulary) and returns a JSON serialization of the result set
    • Xml Query (in MQL Vocabulary)
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doXmlQueryToCdaJson - Executes a XML query (in MQL Vocabulary) and returns a CDA compatible JSON serialization of the result set
    • Xml Query (in MQL Vocabulary)
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doJsonQuery - Executes a JSON query and returns a serializable result set
    • JSON Query
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doJsonQueryToJson - Executes a JSON query and returns a JSON serialization of the result set
    • JSON Query
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows
  • doJsonQueryToCdaJson - Executes a JSON query and returns a CDA compatible JSON serialization of the result set
    • JSON Query
    • rowLimit - An optional integer indicating the maximum number of rows. -1 or null means all rows

listBusinessModels

Code Block

GET http://localhost:8080/pentaho/content/ws-run/metadataService/listBusinessModels

<?xml version="1.0"?>
<ns:listBusinessModelsResponse 
  xmlns:ns="http://service.metadata.ui.common.pentaho.org" 
  xmlns:ax2950="http://util.java/xsd" 
  xmlns:ax2944="http://impl.model.metadata.ui.common.pentaho.org/xsd" 
  xmlns:ax2942="http://logging.commons.apache.org/xsd" 
  xmlns:ax2946="http://marshal.connection.commons.pentaho.org/xsd" 
  xmlns:ax2947="http://connection.commons.pentaho.org/xsd" 
  xmlns:ax2939="http://io.java/xsd"
>
  <return type="org.pentaho.common.ui.metadata.model.impl.ModelInfo">
    <domainId>steel-wheels/metadata.xmi</domainId>
    <modelDescription>This model contains information about Employees.</modelDescription>
    <modelId>BV_HUMAN_RESOURCES</modelId>
    <modelName>Human Resources</modelName>
  </return>
  <return type="org.pentaho.common.ui.metadata.model.impl.ModelInfo">
    <domainId>steel-wheels/metadata.xmi</domainId>
    <modelDescription>This model contains information about products and product inventory.</modelDescription>
    <modelId>BV_INVENTORY</modelId>
    <modelName>Inventory</modelName>
  </return>
  <return type="org.pentaho.common.ui.metadata.model.impl.ModelInfo">
    <domainId>steel-wheels/metadata.xmi</domainId>
    <modelDescription>This model contains information about customers and their orders.</modelDescription>
    <modelId>BV_ORDERS</modelId>
    <modelName>Orders</modelName>
  </return>
</ns:listBusinessModelsResponse>

listBusinessModelsJson

loadModel

...