Forum Discussion

Ricardo's avatar
Ricardo
New Contributor
2 months ago

Identifying API Parameters for OneStream Audit Log Export via Postman

Hello all,

I joined a company where they have implemented OneStream solution. I have access to the platform, and still exploring the way it was implemented.

I am currently working on integrating OneStream with an external platform and need to export audit logs using the product's API. While setting up the request in Postman, i've encountered difficulty identifying the correct values for the following parameters:

ApplicationName
AdapterName


Despite reviewing the available documentation, these tags remain unclear. Has anyone successfully queried audit logs via the OneStream API and can share insights on where these parameters are defined or how to retrieve them?

Any guidance or examples would be greatly appreciated.

Thank you in advance!

 

 

3 Replies

  • JackLacava's avatar
    JackLacava
    Icon for OneStream Employee rankOneStream Employee

    ApplicationName is the name of the OneStream application you're connecting to.

    AdapterName is the name of the Data Adapter being executed - note how the api you call is named "GetAdoDataSetForAdapter" ? A Data Adapter is an artefact that returns some data (for example, from an SQL query). There can be dozens of them in any application, so you have to specify which one you want to get data from.

    Note that this API is not focused on audit logs, it's a generic way to extract data from Onestream. For this to work, someone must have configured an adapter inside a Onestream application to return the relevant information.

  • Ricardo's avatar
    Ricardo
    New Contributor

    Thank you for  your explanation. I managed to extract system logs concerning audit logs. Now my goal is to extract applications changes, workflows executions and other changes. My big challenge here, and you mentioned that, it is that API is focused on data extract and not audit logs. But i just want audit logs, for example who executed Workflows, changed or created them, identities creation and so on. So im more focused on security data than business data. Is there a specific table or cube?

  • RobbSalzmann's avatar
    RobbSalzmann
    Valued Contributor II

    I would avoid the REST API for this and write a simple Extender business rule that queries the audit tables and puts that data in table(s) staged in your local RDBMS for reporting as needed.  Reference the Extender rule in a Data Management Sequence & Step,  and automate the data pulls nightly using Task Manager from the Marketplace.

    You can learn about what data is in which table in the OS repository by going to the System tab, click Database, then Application Database, then Tables.  Here you can see all the tables, their columns, and the data.