Exago Logo
Search
Generic filters
Exact matches only
API

.NET API Documentation

Integration Example

This video describes a minimum viable implementation of Exago BI using the BATCH feature of our REST API and the JavaScript library.<< Roles Previous VideoTranscript Welcome back to the Exago Technical Training Series! IN this video we will demonstrate a minimum viable integration of ...

WebReports.Api

An Api object should be the first thing that is created to interact with the Exago .NET API.

REST Updates

This article logs changes made in the REST Web Service API.

REST – SchedulesV2

Viewing, creating, modifying, and deleting schedules via the REST Web Service API is available in Exago v2021.1.1+. This feature requires the installation and proper configuration of the Scheduler Service.

REST – Server Events

Server events can be accessed for reference and disabled for the session. Server events cannot currently be created or edited using REST.

REST – Sessions

Sessions are the means by which REST persists changes through multiple API calls. A REST session allows for you to easily encapsulate a group of user-specific changes.

REST – Storage Management

Viewing and modifying the Storage Management configuration via the REST Web Service API is available in Exago v2020.1+.

Supply SQL for New Reports in the API

NoteThis version of the .NET API documentation is deprecated. A new version can be found at https://exagobi.com/support/administrators/net-api-docs/. Now available in v2017.1 is the much-requested ability to generate SQL for new reports using the API. After creating an API object, but before ...

User Identification

User logins must be handled by a security layer in the embedding host application. After a user logs in, the host application should pass identification parameters to the Exago API, which can be used to set permissions on content and data objects within Exago.

Using JSON

The Exago REST API is JSON-based.Data sent to the API methods is formatted in JSON, and the methods return JSON formatted response objects. In order to use the REST API you need to convert your data to, and from JSON. What is JSON? JSON is a data-interchange format that is ...

Using the Administration Console and Exago API

NoteThis version of the .NET API documentation is deprecated. A new version can be found at https://exagobi.com/support/administrators/net-api-docs/. Introduction: Understanding the Relationship The Exago Administration Console and API are used to control and configure a set of metadata that ...

WebReports.Api.Common

The Common namespace contains classes used to manage reports and folders.

WebReports.Api.Composite.Chained

The Chained namespace contains classes used to interact with Chained Reports.

WebReports.Api.Composite.Dashboards

The Dashboard namespace contains classes used to interact with Dashboards.

WebReports.Api.Data

The Data namespace contains classes used to interact with data sources and admin console config settings.

WebReports.Api.Reports

The Reports namespace contains classes used to interact with reports, entities (data objects) and joins.

WebReports.Api.Roles

Note This version of the .NET API documentation is deprecated. A new version can be found at https://exagobi.com/support/administrators/net-api-docs/. Classes are listed below in alphabetical order by class name. DataObject Class The DataObject class can allow or deny access to specific Data ...

WebReports.Api.Scheduler

The Scheduler namespace contains classes used to schedule reports and for interacting with Scheduler Services. This version of the .NET API documentation is deprecated. A new version can be found at https://www.exagoaccess.com/api-docs/.

.NET Sample Code

Examples of how to use the .NET API for various features and functions.