Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

App endpoints for SDR forms

Parent article

These are a few API endpoints that you can also use to run the app. To perform a command, alter this example to match your parameters:

http://{host}/pentaho/plugin/{pluginID}/api/{command}

Here are a couple of examples using some parameters:

  • Genre Selector API

    http://localhost:8080/pentaho/plugin/SDR/api/genre
  • Example Response

    {"metadata":[{"colIndex":0,"colType":"String","colName":"GenreID"},{"colIndex":1,"colType":"String","colName":"Genre"}],"queryInfo":{"totalRows":18},"resultset":[["Action","Action"],["Adventure","Adventure"],["Animation","Animation"],["Childrens","Childrens"],["Comedy","Comedy"],["Crime","Crime"],["Documentary","Documentary"],["Drama","Drama"],["Fantasy","Fantasy"],["Film-Noir","Film-Noir"],["Horror","Horror"],["Musical","Musical"],["Mystery","Mystery"],["Romance","Romance"],["Sci-Fi","Sci-Fi"],["Thriller","Thriller"],["War","War"],["Western","Western"]]}
  • Gender Selector API

    http://localhost:8080/pentaho/plugin/SDR/api/gender
  • Example Response

    {"metadata":[{"colIndex":0,"colType":"String","colName":"GenderID"},{"colIndex":1,"colType":"String","colName":"Gender"}],"queryInfo":{"totalRows":2},"resultset":[["M","Male"],["F","Female"]]}

Here is a list of app endpoint parameters:

EndpointDescription
genrePopulates the options for the genre selector.
genderPopulates the options for the gender selector.
occupationPopulates the options for the occupation selector.
incomePopulates the options for the income selector.
firstdateReturns the limit dates for the data to be processed.
data_source_nameReturns the names of all data sources available on the server.
latest_requestsReturns the latest 10 requests made in a table, instead of inside of a popup.
sdr_dataProcesses the request and returns the status of the data.
refreshRefreshes the kettle and dashboard elements to reflect any saved changes. Clears the cache for all kettle endpoints.
A larger number of API endpoints can be found in the Developer center.