Version 2021

What's New in the REST APIs

In each release, changes are made to make the MicroStrategy REST APIs more powerful and easier to use.

2021 Update 5

2021 Update 3

2021 Update 2

2021 Update 1

2021

  • Identify applications to load on server startup.
  • Manage filter objects through the Modeling service.
  • Create and edit email subscriptions.
  • List available recipients for a given user, including Shared List and Personal Addresses.
  • Execute a single subscription on demand.
  • Create, update, and delete schedules.
  • Manage data sources with a complete set of REST APIs.
  • Ability to request DateTime data to be returned from reports, cubes, and dossiers in the ISO 8601 format.
  • Ability to update page-by selections for reports.
  • Enhancement to APIs returning data from reports and cubes to allow the modification of attribute and metric template positioning.
  • Enhancement to APIs that execute reports, cubes, and dossiers to allow the request for asynchronous executions.
  • Monitor and manage cubes. This includes viewing and changing the status of a cube.
  • Additional server and application level settings from MicroStrategy Developer are available in MicroStrategy Workstation.
  • Ability to request object lineage information.
  • Create, list, and delete multi-content subscriptions.

2020 Update 2

2020 Update 1

  • Manage server-level privileges
  • Control the presence of subtotals in report data when consumed using REST.
  • Generate report and cube instances asynchronously.

2020

2019

  • Push Data API has been enhanced.

    The ability to make external data available to MicroStrategy—often referred to as the Push Data API—has been enhanced. The newest version of the Push Data API supports complex scenarios where a large number of columns/metrics need to be managed at a different update/load/refresh schedule. This is accomplished by separating dataset definition, data upload, and dataset creation, using multiple requests to incrementally add data before publication.

    Performance was significantly improved for Data Import using the Push Data API (with multiple requests), and issues were addressed for stability improvements.

  • Filtering data has been enhanced

    The REST API has been enhanced to support the ability to pass filters into the REST API endpoints.

  • Support for prompts has been enhanced.

    The REST API has been enhanced to support the ability to programmatically view, answer (with specific values, no answers, or default answers), and reset prompts on reports, dossiers, and documents.

  • Exporting data has been enhanced.

    The REST API now supports the export of cross-tabbed reports and report sub-totals. Additionally, the REST API has been enhanced to allow for greater scalability, so users can consume larger datasets in less time.

11.0

10.11

  • The stand-alone JSON Data API Server has been removed.

    The JSON Data API is made up of four different MicroStrategy API families. All of these families are part of the MicroStrategy REST Server, which is shipped inside the MicroStrategyLibrary.war web application.

10.10

10.9

  • The MicroStrategy REST API has been unified and expanded to include the following REST API families:

    • Authentication API
    • Browsing API
    • Cubes API
    • Datasets API
    • Datasource Management API
    • Dossiers and Documents API
    • Emails API
    • Library API
    • Object Management API
    • Projects API
    • Reports API
    • Security Roles API
    • System Administration API
    • User Management API
  • The /reports endpoint accepts the requestedObjects parameter, allowing the caller to dynamically decide which objects to include on the template when the data is returned. Previously, only the /cubes endpoint accepted the requestedObjects parameter. However ,there is a difference in the implementation for reports and cubes. When requestedObjects is null for the /reports endpoint, the result of the original template is returned and nothing is done; for the /cubes endpoint, all attributes and metrics in the working set are added to the template and the result is run.

  • You can view and use all of the MicroStrategy REST API endpoints in the MicroStrategy REST API Explorer.
  • Quick Start Guides illustrate how to use the MicroStrategy REST API for common workflows, including folder browsing, searching, creating and modifying datasets, and exporting a document to PDF.
  • The JSON Data API and Push Data API are part of the unified MicroStrategy REST platform. This platform is contained within the MicroStrategyLibrary war file, which can be deployed to application servers.
  • The current packaging of the JSON Data API (jar deployment) has been deprecated. It will be supported until the next platform release.

  • X-MSTR-ProjectID has been added for every endpoint to provide context. The X-MSTR-AuthToken stores a reference to all of the user's sessions in memory on the MicroStrategy REST Server, abstracting project session creation and management from the end user.

  • The result format for error cases has been changed. This information is available in the MicroStrategy REST API Explorer.
  • The version information included in the ContentType and Accept headers has been removed.

10.8

There were no significant changes from the previous version.

10.7

  • The JSON Data API content has been moved from the Web SDK and is part of the new REST API.
  • A new RESTful Dataset API lets you modify a dataset that was created using the Dataset API. You can add new data and modify existing data in the dataset.

10.6

REST SDK content was included in the Web SDK, under the JSON Data API section, until 10.7.

10.5

REST SDK content was included in the Web SDK, under the JSON Data API section, until 10.7.

  • A new RESTful View Filter API lets you refine the data returned from a report or cube using a variety of operators.