Data Engine REST User API

Data

getData

Get rows

Retrieves data rows from the specified table or view. Note that column names returned in the result section are not JSON standardized, they represent the actual name of the column and may contain foreign, unknown and ill formatted characters.


/data/{table_id}/select

Usage and SDK Samples

curl -X POST "https://api.dataengine.accessacloud.com/data/{table_id}/select?page=&page_size=&api_version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        
        DataApi apiInstance = new DataApi();
        Integer tableId = 56; // Integer | 
        Infinis.WebAPI.v2022_01.Datas.RowFilterModel model = ; // Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Datas.DocumentationWorkAroundJObject result = apiInstance.getData(tableId, model, apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer tableId = 56; // Integer | 
        Infinis.WebAPI.v2022_01.Datas.RowFilterModel model = ; // Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Datas.DocumentationWorkAroundJObject result = apiInstance.getData(tableId, model, apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getData");
            e.printStackTrace();
        }
    }
}
Integer *tableId = 56; // 
Infinis.WebAPI.v2022_01.Datas.RowFilterModel *model = ; // 
BigDecimal *apiVersion = 8.14; // The requested API version
Integer *page = 56; // Page number. (optional) (default to 1)
Integer *pageSize = 56; // Number of results returned per page. (optional) (default to 100)

DataApi *apiInstance = [[DataApi alloc] init];

// Get rows
[apiInstance getDataWith:tableId
    model:model
    apiVersion:apiVersion
    page:page
    pageSize:pageSize
              completionHandler: ^(Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Datas.DocumentationWorkAroundJObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataEngineRestUserApi = require('clic_data_rest_user_api');

var api = new DataEngineRestUserApi.DataApi()

var tableId = 56; // {Integer} 

var model = ; // {Infinis.WebAPI.v2022_01.Datas.RowFilterModel} 

var apiVersion = 8.14; // {BigDecimal} The requested API version

var opts = { 
  'page': 56, // {Integer} Page number.
  'pageSize': 56 // {Integer} Number of results returned per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getData(tableId, model, apiVersion, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataExample
    {
        public void main()
        {
            
            var apiInstance = new DataApi();
            var tableId = 56;  // Integer | 
            var model = new Infinis.WebAPI.v2022_01.Datas.RowFilterModel(); // Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
            var apiVersion = 8.14;  // BigDecimal | The requested API version
            var page = 56;  // Integer | Page number. (optional)  (default to 1)
            var pageSize = 56;  // Integer | Number of results returned per page. (optional)  (default to 100)

            try
            {
                // Get rows
                Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Datas.DocumentationWorkAroundJObject result = apiInstance.getData(tableId, model, apiVersion, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DataApi();
$tableId = 56; // Integer | 
$model = ; // Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
$apiVersion = 8.14; // BigDecimal | The requested API version
$page = 56; // Integer | Page number.
$pageSize = 56; // Integer | Number of results returned per page.

try {
    $result = $api_instance->getData($tableId, $model, $apiVersion, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $tableId = 56; # Integer | 
my $model = WWW::SwaggerClient::Object::Infinis.WebAPI.v2022_01.Datas.RowFilterModel->new(); # Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
my $apiVersion = 8.14; # BigDecimal | The requested API version
my $page = 56; # Integer | Page number.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->getData(tableId => $tableId, model => $model, apiVersion => $apiVersion, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DataApi()
tableId = 56 # Integer | 
model =  # Infinis.WebAPI.v2022_01.Datas.RowFilterModel | 
apiVersion = 8.14 # BigDecimal | The requested API version
page = 56 # Integer | Page number. (optional) (default to 1)
pageSize = 56 # Integer | Number of results returned per page. (optional) (default to 100)

try: 
    # Get rows
    api_response = api_instance.get_data(tableId, model, apiVersion, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getData: %s\n" % e)

Parameters

Path parameters
Name Description
table_id*
Integer (int32)
Required
Body parameters
Name Description
model *
Query parameters
Name Description
page
Integer (int32)
Page number.
page_size
Integer (int32)
Number of results returned per page.
api_version*
BigDecimal
The requested API version
Required

Responses

Status: 200 - Table delete result

{success=true, pagination={result_count=10, result_total_count=15, current_page=1, page_size=10, has_more_results=true}, result=[{Year=2018, Model Type=Mercedes, Car Type=Berline, Sales Units=12500, Target Units=30000, Sales=15487, Cost=80000, Profit=20000}]}

Table

allTable

List Tables

Retrieves the list of Tables for the account.


/table

Usage and SDK Samples

curl -X GET "https://api.dataengine.accessacloud.com/table?page=&page_size=&api_version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TableApi;

import java.io.File;
import java.util.*;

public class TableApiExample {

    public static void main(String[] args) {
        
        TableApi apiInstance = new TableApi();
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Tables.TableModel result = apiInstance.allTable(apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableApi#allTable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TableApi;

public class TableApiExample {

    public static void main(String[] args) {
        TableApi apiInstance = new TableApi();
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Tables.TableModel result = apiInstance.allTable(apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TableApi#allTable");
            e.printStackTrace();
        }
    }
}
BigDecimal *apiVersion = 8.14; // The requested API version
Integer *page = 56; // Page number. (optional) (default to 1)
Integer *pageSize = 56; // Number of results returned per page. (optional) (default to 100)

TableApi *apiInstance = [[TableApi alloc] init];

// List Tables
[apiInstance allTableWith:apiVersion
    page:page
    pageSize:pageSize
              completionHandler: ^(Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Tables.TableModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataEngineRestUserApi = require('clic_data_rest_user_api');

var api = new DataEngineRestUserApi.TableApi()

var apiVersion = 8.14; // {BigDecimal} The requested API version

var opts = { 
  'page': 56, // {Integer} Page number.
  'pageSize': 56 // {Integer} Number of results returned per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allTable(apiVersion, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class allTableExample
    {
        public void main()
        {
            
            var apiInstance = new TableApi();
            var apiVersion = 8.14;  // BigDecimal | The requested API version
            var page = 56;  // Integer | Page number. (optional)  (default to 1)
            var pageSize = 56;  // Integer | Number of results returned per page. (optional)  (default to 100)

            try
            {
                // List Tables
                Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Tables.TableModel result = apiInstance.allTable(apiVersion, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TableApi.allTable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TableApi();
$apiVersion = 8.14; // BigDecimal | The requested API version
$page = 56; // Integer | Page number.
$pageSize = 56; // Integer | Number of results returned per page.

try {
    $result = $api_instance->allTable($apiVersion, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TableApi->allTable: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TableApi;

my $api_instance = WWW::SwaggerClient::TableApi->new();
my $apiVersion = 8.14; # BigDecimal | The requested API version
my $page = 56; # Integer | Page number.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->allTable(apiVersion => $apiVersion, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TableApi->allTable: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TableApi()
apiVersion = 8.14 # BigDecimal | The requested API version
page = 56 # Integer | Page number. (optional) (default to 1)
pageSize = 56 # Integer | Number of results returned per page. (optional) (default to 100)

try: 
    # List Tables
    api_response = api_instance.all_table(apiVersion, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TableApi->allTable: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer (int32)
Page number.
page_size
Integer (int32)
Number of results returned per page.
api_version*
BigDecimal
The requested API version
Required

Responses

Status: 200 - Table List

{success=true, pagination={result_count=10, result_total_count=15, current_page=1, page_size=10, has_more_results=true}, result=[{id=210, name=my Table, created_by=123, created_on=2021-01-01T12:00:00Z, created_by_id=0, last_modified_by=123, last_modified_on=2021-01-01T12:00:00Z, last_modified_by_id=null, owner_id=1234, owner_name=John Smith, description=Table description, tags=[my tag, my tag2], folder_id=null, last_data_update_date=2021-01-01T12:00:00Z, version=5, live_link=https://app.DataEngine.com/d/xxxxxxx, history_enabled=true, history_count_limit=30, row_count=3210, connection_id=123, connection_name=My Oracle DB, connection_code=oracle, current_version_size_bytes=152345, total_size_bytes=975446, thumbprint=d81daa3f-0cdf-429d-86e7-d4c4fb0f1ab8}]}

View

allView

List Views

Retrieves the list of Views, Merges and Fusions for the account.


/view

Usage and SDK Samples

curl -X GET "https://api.dataengine.accessacloud.com/view?page=&page_size=&api_version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ViewApi;

import java.io.File;
import java.util.*;

public class ViewApiExample {

    public static void main(String[] args) {
        
        ViewApi apiInstance = new ViewApi();
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Views.ViewModel result = apiInstance.allView(apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewApi#allView");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ViewApi;

public class ViewApiExample {

    public static void main(String[] args) {
        ViewApi apiInstance = new ViewApi();
        BigDecimal apiVersion = 8.14; // BigDecimal | The requested API version
        Integer page = 56; // Integer | Page number.
        Integer pageSize = 56; // Integer | Number of results returned per page.
        try {
            Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Views.ViewModel result = apiInstance.allView(apiVersion, page, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ViewApi#allView");
            e.printStackTrace();
        }
    }
}
BigDecimal *apiVersion = 8.14; // The requested API version
Integer *page = 56; // Page number. (optional) (default to 1)
Integer *pageSize = 56; // Number of results returned per page. (optional) (default to 100)

ViewApi *apiInstance = [[ViewApi alloc] init];

// List Views
[apiInstance allViewWith:apiVersion
    page:page
    pageSize:pageSize
              completionHandler: ^(Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Views.ViewModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DataEngineRestUserApi = require('clic_data_rest_user_api');

var api = new DataEngineRestUserApi.ViewApi()

var apiVersion = 8.14; // {BigDecimal} The requested API version

var opts = { 
  'page': 56, // {Integer} Page number.
  'pageSize': 56 // {Integer} Number of results returned per page.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allView(apiVersion, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class allViewExample
    {
        public void main()
        {
            
            var apiInstance = new ViewApi();
            var apiVersion = 8.14;  // BigDecimal | The requested API version
            var page = 56;  // Integer | Page number. (optional)  (default to 1)
            var pageSize = 56;  // Integer | Number of results returned per page. (optional)  (default to 100)

            try
            {
                // List Views
                Infinis.WebAPI.API.Objects.ApiListResponseOfInfinis.WebAPI.v2022_01.Views.ViewModel result = apiInstance.allView(apiVersion, page, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ViewApi.allView: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ViewApi();
$apiVersion = 8.14; // BigDecimal | The requested API version
$page = 56; // Integer | Page number.
$pageSize = 56; // Integer | Number of results returned per page.

try {
    $result = $api_instance->allView($apiVersion, $page, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ViewApi->allView: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ViewApi;

my $api_instance = WWW::SwaggerClient::ViewApi->new();
my $apiVersion = 8.14; # BigDecimal | The requested API version
my $page = 56; # Integer | Page number.
my $pageSize = 56; # Integer | Number of results returned per page.

eval { 
    my $result = $api_instance->allView(apiVersion => $apiVersion, page => $page, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ViewApi->allView: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ViewApi()
apiVersion = 8.14 # BigDecimal | The requested API version
page = 56 # Integer | Page number. (optional) (default to 1)
pageSize = 56 # Integer | Number of results returned per page. (optional) (default to 100)

try: 
    # List Views
    api_response = api_instance.all_view(apiVersion, page=page, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ViewApi->allView: %s\n" % e)

Parameters

Query parameters
Name Description
page
Integer (int32)
Page number.
page_size
Integer (int32)
Number of results returned per page.
api_version*
BigDecimal
The requested API version
Required

Responses

Status: 200 - View List

{success=true, pagination={result_count=10, result_total_count=15, current_page=1, page_size=10, has_more_results=true}, result=[{id=210, name=my table, created_by=null, created_on=2021-01-01T12:00:00Z, created_by_id=123, last_modified_by=null, last_modified_on=2021-01-01T12:00:00Z, last_modified_by_id=123, owner_id=1234, owner_name=John Smith, description=My description, tags=[my tag, my tag2], folder_id=null, type=view, live_link=https://app.DataEngine.com/d/xxxxxxx, row_count=3210, source=null, thumbprint=fc5af341-c8ab-44d2-8482-06597f2c81ff}]}