OneStream

App · 7 actions

Run Data Management sequences and steps and read data from data adapters, cube views and queries in OneStream.

Actions

ActionWhat it does
Get cube view resultsGet the rows of a cube view as a table.
Get data adapter resultsGet the rows a dashboard data adapter returns.
List applicationsList the OneStream applications this connection may open.
Run data management sequenceRun a Data Management sequence, such as a consolidation or an export, and wait for it to finish.
Run data management stepRun one step of a Data Management group and wait for it to finish.
Run method queryGet workflow, journal, form, certification or intercompany status from one of OneStream's built-in method queries.
Run SQL queryRun a SQL query against the application's database, or an external database OneStream is set up to reach, and get the rows.

Get cube view results

Get the rows of a cube view as a table.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
Cube viewcube_view_nametextRequired
The name of the cube view.
One table per rowtable_per_rowtrue/false
Turn on to get a separate table for each row of the cube view.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "row_count": 1,
    "rows": [
      {}
    ],
    "tables": {}
  }
}

Get data adapter results

Get the rows a dashboard data adapter returns.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
Data adapteradapter_nametextRequired
The name of the dashboard data adapter.
System-level adaptersystem_leveltrue/false
Turn on when the data adapter is defined at the system level rather than in the application.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "row_count": 1,
    "rows": [
      {}
    ],
    "tables": {}
  }
}

List applications

List the OneStream applications this connection may open.

Inputs

None.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "applications": [
      "example"
    ],
    "count": 1
  }
}

Run data management sequence

Run a Data Management sequence, such as a consolidation or an export, and wait for it to finish.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
Sequence namesequence_nametextRequired
The name of the sequence, as it appears under Data Management.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.
Workspaceworkspace_nametext
The workspace that holds the sequence. Leave empty for the default workspace.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "message": "example"
  }
}

Run data management step

Run one step of a Data Management group and wait for it to finish.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
Group namegroup_nametextRequired
The Data Management group that holds the step.
Step namestep_nametextRequired
The name of the step to run.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "message": "example"
  }
}

Run method query

Get workflow, journal, form, certification or intercompany status from one of OneStream's built-in method queries. Needs the Administrator role in OneStream.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
Methodmethod_typetextRequired
Which built-in method query to run.One of: WorkflowCalculationEntities, WorkflowConfirmationEntities, WorkflowProfileAndDependentProfileEntities, WorkflowProfileEntities, WorkflowProfiles, WorkflowProfileRelatives, WorkflowStatus, WorkflowStatusTwelvePeriod, WorkflowAndEntityStatus, JournalsForWorkflowUnit, and 7 more.
Method querymethod_querytextRequired
The method query's arguments, such as `{Houston}{Actual}{2018M1}{true}{}` for a workflow unit.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "row_count": 1,
    "rows": [
      {}
    ],
    "tables": {}
  }
}

Run SQL query

Run a SQL query against the application's database, or an external database OneStream is set up to reach, and get the rows. Needs the Administrator role in OneStream.

Inputs

ApplicationapplicationtextRequired
The OneStream application to work in.
SQL querysql_querytextRequired
The SQL query, such as `SELECT TOP 100 * FROM Cube`.
Databasedatabasetext
Which database to query. Defaults to the application's database.One of: Application, External. Default: Application.
External connectionexternal_connectiontext
The name of the external database connection in OneStream. Needed when Database is External.
Substitution variablesvariablestext
Substitution variables for OneStream to fill in, as comma-separated name and value pairs written the way OneStream expects them. Leave empty when there are none.

Outputs

dataobject
The response from OneStream.
Example output
{
  "data": {
    "row_count": 1,
    "rows": [
      {}
    ],
    "tables": {}
  }
}

On this page