Web Tier APIs - Home

Skip to end of metadata
Go to start of metadata

Collaboration area for the Pentaho BI Server Web Tier APIs. Although Web Services have been available in the BI Server for a long time, they are not documented and not cast in stone yet.


First cut at high level model - Andy Grohe


Use Cases:

As a designer, I would like to use the platform Web API's to build custom BI solutions. NOTE for a recommended list of Pentaho resource-oriented services, see Pentaho Resources

Security

  • Retrieve a list of platform users
  • Retrieve a list of platform roles
  • CRUD for Access Control Lists
  • CRUD for user preferences
  • Authenticate an external user to the platform

    Metadata/Adhoc

  • Retrieve a list of Business Models available to the logged in user from the Solution Repository
  • Retrieve a list of business views for a business model
  • Retrieve a list of business columns for a business view
  • Add new business views and columns to an existing business model
  • Execute a metadata based query without previously creating an action

    OLAP/Analysis

  • Retrieve a list of OLAP schemas available to the logged in user from the Solution Repository
  • Retrieve a list of cubes (regular or virtual) for an OLAP schema
  • Retrieve a list of dimensions, measures and named sets for a cube
  • Execute an OLAP/MDX/XMLA based query without previously creating an action
  • Retrieve a list of roles for an OLAP schema
  • Retrieve a list of parameters for an OLAP schema

    Solution Repository

  • Retrieve a list of actions available to the logged in user from the Solution Repository
  • Retrieve a list of actions currently being executed by the platform (either scheduled or background)
  • Retrieve a list of previously executed actions from the content repository (either scheduled or background)
  • Retrieve a list of content handlers for all types of actions (xaction=ViewAction, analysisview.xactcion=pivot, etc...)
  • Execute an action and display generated content (generally HTML)
  • Execute an action and retrieve the results data (JSON or XML)
  • Discover the parameters for an action before execution (JSON or XML)
  • Add a new action to the repository
  • Remove an action from the repsitory
  • Update an existing action state to the repository
  • Load existing action state from the repository
  • Schedule action for immediate, delayed or recurring execution
  • Specify action delivery to (screen, inbox, email, rss feed, printer, jms, file)
  • Update action ACL
  • Retrieve existing action input and output parameters from repository (source, datatype, and defaults)
  • Add a user rating to an action
  • View user ratings for one or more actions

Content Repository

  • Retrieve list of previously executed actions
  • Filter content based on criteria (user, role, time, type (html,PDF), frequency(10 run, 10 least run), recency(first 10, last 10), execution type (online/request, background, scheduled))

Service Definitions:

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.