Versions Compared

Key

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

...

The expanded range of REST API allows you to create your own applications in Visual LANSA, having multiple seamless integrations with LANSA BI’s reports, dashboards, and content.

The REST API provides important functionality to help you automate key processes, such as automating the onboarding of new clients in a multi-tenant environment, building custom embedded applications using LANSA BI in Visual LANSA, and integrating LANSA BI content (users, stories, signals, reports, etc) inside a LANSA application. 

...

  • Content endpoint: returns a list of all content accessible to a user, including Views, Reports, Dashboards, Stories, and more. It allows further ability to build custom content browsing solution in an embedded BI scenario.
  • Dashboards, presentations, and themes endpoints: retrieves a list of items or detailed information for a specific content item.
  • Health endpoint: returns the overall health of a Yellowfin deployment, including clustered deployments. There are two forms:
    • Ping endpoint: returns limited information, and it does not require authentication.
    • Full health endpoint: returns comprehensive information about the deployment.
  • Users and import-export endpoints: updates the user profile information, such as timezone, language preference, and lists the dependencies of a Content Item from within an Import File.
  • Cached filter refreshes: the REST endpoints trigger cached filter refreshes for Dashboards and Views.
  • API integration: allows external developers to get information about the user and organization in a user-friendly interface. It eliminates the need to reference internal Yellowfin methods to get the current user, role, or client organization when developing custom headers, JSPs, and internal plugins like formatters and analytic functions.

...