OneStream Web API Endpoints

URLs are relative to query parameter api-version=5.2.0, unless otherwise noted.

Authentication

Authentication endpoint. Represents a RESTful service for Authentication.

• POST api/Authentication/LogonAndReturnCookie

  Used primarily to verify Web API installation completed successfully. Returns an authentication message or a message indicating failure along with a proper HTTP code.

DataManagement

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

DataProvider endpoint represents a RESTful service of Data Provider.

• POST api/DataProvider/GetAdoDataSetForAdapter:

  Executes a Data Provider HTTP Post request and returns a JSON representation of a DataSet for a given Dashboard Adapter.

• POST api/DataProvider/GetAdoDataSetForCubeViewCommand

  Executes a Data Provider HTTP Post request and returns a JSON representation of a DataSet for a given Cube View.

• POST api/DataProvider/GetAdoDataSetForSqlCommand

  Executes a Data Provider HTTP Post request and returns a JSON representation of a DataSet for a given Sql query. Administrator role is required for this functionality.

• POST api/DataProvider/GetAdoDataSetForMethodCommand

  Executes a Data Provider HTTP Post request and returns a JSON representation of a DataSet for a given pre-defined list of method commands. Administrator role is required for this functionality.

Call State For Long Running Requests

To prevent proxy appliance time-out, a polling method was introduced for long running requests. When this is enabled, all requests use the polling method based on the configured setting in the XFAppServerConfig.xml indicating how long the request has to complete. This allows long running requests to complete without the proxy appliances returning a 502 Bad Gateway as a response to the request inactivity that causes the proxy to terminate the connection.

How It Works

XFCallState polling must first be enabled in the XFAppServerConfig.xml in the EnvironmentSettings block.

The configured values of UseCallStateForLongRunningRequests and CallStateNetworkTimeoutNumSeconds manage the XFCallState functionality. When UseCallStateForLongRunningRequests is set to true, call state polling is used. The configured value for CallStateNetworkTimeoutNumSeconds determines the time to wait before using call state to complete the request, default 120 seconds.