Exposing Data Management Automation through OneStream Web API

OneStream Web API is a RESTful web service designed to expose OneStream Data Automation functions when interacting with third-party API client applications.

OneStream Web API must be installed on a web server. It also must be configured for external authentication providers supporting OAuth2.0/OpenID Connect authorization protocol. Identity Providers currently supported are Okta, Azure AD (Microsoft Entra ID), and PingFederate.

OneStream Web API is API client agnostic. It accepts and outputs data in JSON format making it possible for every API client application that supports this format to also interact with this service. One of the most widely used API clients is Postman, a Windows app. For more information about how to configure OneStreamWeb API to interact with Postman see the autogenerated documentation at http(s)://[servername]:[port]/onestreamapi.

OneStream Web API endpoints:

Authentication endpoint. Represents a RESTful service for Authentication.

  • POST api/Authentication/LogonAndReturnCookie

    Used primarily by the Enablement Team to verify Web API installation completed successfully. Returns a one-time cookie value that holds authentication state or a message indicating failure along with a proper HTTP code.

DataManagement endpoint. Represents a RESTful service of Data Management.

  • POST api/DataManagement/ExecuteSequence:

    Executes a Data Management Sequence and returns a success/failure message along with a proper HTTP code.

  • POST api/DataManagement/ExecuteStep

    Executes a Data management Step and returns a success/failure message along with a proper HTTP code.

DataProvider endpoint. Represents a RESTful service of Data Provider

  • POST api/DataProvider/GetAdoDataSetForAdapter

    Returns a JSON representation of a DataSet a given Dashboard Adapter or a failure message along with a proper HTTP code.

  • POST api/DataProvider/GetAdoDataSetForCubeViewCommand

    Returns a JSON representation of a DataSet for a given Cube View or a failure message along with a proper HTTP code.

  • POST api/DataProvider/GetAdoDataSetForSqlCommand

    Returns a JSON representation of a DataSet for a given SQL Query or a failure message along with a proper HTTP code.  Administrator role is required for this functionality.

  • POST api/DataProvider/GetAdoDataSetForMethodCommand

    Returns a JSON representation of a DataSet for a given pre-defined list of method commands used by XFDataProvider to fill a DataSet or a failure message along with a proper HTTP code. Administrator role is required for this functionality.