The unofficial .NET/C# client library for the Sisense API.

I develop this library in my spare time, so if you need an operation that is not implemented yet, please let me know and I will add it as soon as possible.

I'm testing this library with a Sisense Server 7.1.

In the future I will create a nuget package to easily include in the projects.

using SisenseApiClient;
using SisenseApiClient.Authenticators;

// Create an authenticator with your username and password
var authenticator = new Authenticator("<username>", "<password>");

// Create the Sisense client
var sisenseClient = new SisenseClient("<sisense_server>", authenticator);

// Use one of the services 
var sets = await sisenseClient.ElatiCubes.GetSetsAsync();

For Sisense version 5.8 and earlier, you can use the Global Token located in the Admin page of the Sisense Web Application. If you use a Sisense version later than the 5.8, I suggest you to use the authentication from the previous section to avoid receive 401 Unauthorized responses in some endpoints.

For more information check https://developer.sisense.com/display/API2/Authenticating+Requests+with+a+Global+Token

using SisenseApiClient;
using SisenseApiClient.Authenticators;

// Create an authenticator with your username, password and api key
var authenticator = new GlobalTokenAuthenticator("<username>", "<password>", "<apikey>");

// Create the Sisense client
var sisenseClient = new SisenseClient("<sisense_server>", authenticator);

// Use one of the services 
var sets = await sisenseClient.ElatiCubes.GetSetsAsync();

• GetStatusAsync() - Provides information on the current status of the Sisense application

• LoginAsync(credentials) - Authenticate and receive a token

• v1.0

  • GetSetsAsync() - Get a list of ElastiCube Sets
  • GetSetAsync(setName) - Get an ElastiCube Set
  • GetBuildRevisionAsync(server, cubeName) - Get the ElastiCube build revision
  • GetCustomTablesAsync(server, cubeName) - Get an ElastiCube's custom tables
  • GetCustomTableRelationsAsync(server, cubeName, tableName) - Get an ElastiCube table's relation
  • GetCustomTableAsync(server, cubeName, tableName) - Get an ElastiCube's custom table
  • VerifyConnectivityWithRServerAsync(server, rserver) - Verify connectivity between your ElastiCube server and an R server
  • GetServerSettingsAsync(server) - Returns your ElastiCube server’s settings

• v0.9

  • GetElastiCubesMetadataAsync(query, sortBy) - Returns a list of ElastiCubes with metadata
  • GetElastiCubeMetadataAsync(cubeName) - Returns metadata for an ElastiCube by ElastiCube name
  • GetElastiCubeMetadataFieldsAsync(cubeName, query, offset, count) - Returns fields included in a specific ElastiCube
  • GetServersElastiCubesAsync(query, offset, count, direction, withPermissions) - Returns ElastiCubes with their server and ElastiCube details
  • GetServersMetadataAsync(query, offset, count, direction, withPermissions) - Returns the ElastiCube servers with metadata.
  • GetElastiCubesByServerAsync(server, query, offset, count, orderBy, direction) - Returns all the ElastiCubes by server.
  • GetServerStatusAsync(server, query, offset, count, orderBy, direction) - Returns the status of each ElastiCube in the selected server.
  • GetElastiCubePermissionsAsync(server, cubeName) - Returns all authentication records for the given ElastiCube.
  • StartElastiCubeServerAsync(server, cubeName) - Starts the ElastiCube Server.
  • StopElastiCubeServerAsync(server, cubeName) - Stops the ElastiCube Server.
  • RestartElastiCubeServerAsync(server, cubeName) - Restarts the ElastiCube Server.
  • StartBuildElastiCubeServerAsync(server, cubeName, buildType) - Starts the build process for an ElastiCube.
  • StopBuildElastiCubeServerAsync(server, cubeName) - Stops the build process for an ElastiCube.

• RunAsync(jaqlQuery, cancellationToken) - Runs a JAQL Query and returns the result as a JSON string.
• RunAsync(jaqlQuery) - Runs a JAQL Query and returns the result as a JSON string.
• RunAsync(jaqlQuery, cancellationToken) - Runs a JAQL Query and returns the result as an object of the specified type.
• RunAsync(jaqlQuery) - Runs a JAQL Query and returns the result as an object of the specified type.

• RunAsync(cubeName, sqlQuery, cancellationToken) - Runs a SQL Query and returns the result as a JSON string.
• RunAsync(cubeName, sqlQuery) - Runs a SQL Query and returns the result as a JSON string.
• RunAsync(cubeName, sqlQuery, cancellationToken) - Runs a SQL Query and returns the result as an object of the specified type.
• RunAsync(cubeName, sqlQuery) - Runs a SQL Query and returns the result as an object of the specified type.

Please open an issue for any bugs or questions