Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

http://localhost:8080/pentaho/content/ws-run/metadataService/<method-name>

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

...

Code Block
GET http://localhost:8080/pentaho/content/ws-run/metadataService/listBusinessModelsJson

<ns:listBusinessModelsJsonResponse xmlns:ns="http://service.metadata.ui.common.pentaho.org">
  <return>
  [
    {
      "class":"org.pentaho.common.ui.metadata.model.impl.ModelInfo",
      "domainId":"steel-wheels/metadata.xmi",
      "modelDescription":"This model contains information about Employees.",
      "modelId":"BV_HUMAN_RESOURCES",
      "modelName":"Human Resources"
    },
    {
      "class":"org.pentaho.common.ui.metadata.model.impl.ModelInfo",
      "domainId":"steel-wheels/metadata.xmi",
      "modelDescription":"This model contains information about products and product inventory.",
      "modelId":"BV_INVENTORY",
      "modelName":"Inventory"
    },
    {
      "class":"org.pentaho.common.ui.metadata.model.impl.ModelInfo",
      "domainId":"steel-wheels/metadata.xmi",
      "modelDescription":"This model contains information about customers and their orders.",
      "modelId":"BV_ORDERS",
      "modelName":"Orders"
     }
  ]
  </return>
</ns:listBusinessModelsJsonResponse>

loadModel

Code Block

GET http://localhost:8080/pentaho/content/ws-run/metadataService/loadModel?domainId=steel-wheels%2Fmetadata.xmi&modelId=BV_ORDERS

<?xml version="1.0"?>
<ns:loadModelResponse xmlns:ns="http://service.metadata.ui.common.pentaho.org">
  <return type="org.pentaho.common.ui.metadata.model.impl.Model">
    <categories type="org.pentaho.common.ui.metadata.model.impl.Category">
      <columns type="org.pentaho.common.ui.metadata.model.impl.Column">
        <aggTypes>NONE</aggTypes>
        <category>CAT_PAYMENTS</category>
        <defaultAggType>NONE</defaultAggType>
        <description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
        <fieldType>FACT</fieldType>
        <formatMask>$#,##0.00;($#,##0.00)</formatMask>
        <horizontalAlignment>RIGHT</horizontalAlignment>
        <id>BC_PAYMENTS_AMOUNT</id>
        <name>Amount</name>
        <selectedAggType>NONE</selectedAggType>
        <type>NUMERIC</type>
      </columns>

      ...many more <columns></columns>...

      <description>This category contains details about customer payments.</description>
      <id>CAT_PAYMENTS</id>
      <name>Payments</name>
    </categories>

    ...more <categories></categories>...
    <description>This model contains information about customers and their orders.</description>
    <domainId>steel-wheels/metadata.xmi</domainId>
    <id>BV_ORDERS</id>
    <name>Orders</name>
  </return>
</ns:loadModelResponse>

loadModelJson

Code Block

GET http://localhost:8080/pentaho/content/ws-run/metadataService/loadModelJson?domainId=steel-wheels%2Fmetadata.xmi&modelId=BV_ORDERS

<Exception>org.apache.axis2.AxisFault: Error trying to deepSerialize
    at org.apache.axis2.rpc.receivers.RPCMessageReceiver.invokeBusinessLogic(RPCMessageReceiver.java:158)
    at org.apache.axis2.receivers.AbstractInOutMessageReceiver.invokeBusinessLogic(AbstractInOutMessageReceiver.java:40)
    at org.apache.axis2.receivers.AbstractMessageReceiver.receive(AbstractMessageReceiver.java:100)
    at org.apache.axis2.engine.AxisEngine.receive(AxisEngine.java:176)

...
</Exception>

doQuery

doXmlQuery

doXmlQueryToJson

...

doJsonQueryToJson

doJsonQueryToCdaJson

GWT Webservice API

This document does not describe the GWT style of the API. (Community, feel free to add this documentation).