dseconnect Rest-API

DataQuery

dataquery.exec.get

Execute data query

The execution of a data query with the data query name (dataid) delivers the result.


/de.eoda.dse.portal.dataquery.rest/{dataid}/exec

Usage and SDK Samples

curl -X GET "http://example.com/backend//de.eoda.dse.portal.dataquery.rest/{dataid}/exec?_role=&_refTag=&filter=&_converter=&_currentLanguage="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataQueryApi;

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

public class DataQueryApiExample {

    public static void main(String[] args) {
        
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        String currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        map[String, String] filter = ; // map[String, String] | Filters to apply on the data query.
        Converter converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
        String requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

        try {
            DataQueryResult result = apiInstance.dataquery.exec.get(dataid, currentLanguage, role, refTag, filter, converter, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.exec.get");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataQueryApi;

public class DataQueryApiExample {

    public static void main(String[] args) {
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        String currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        map[String, String] filter = ; // map[String, String] | Filters to apply on the data query.
        Converter converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
        String requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

        try {
            DataQueryResult result = apiInstance.dataquery.exec.get(dataid, currentLanguage, role, refTag, filter, converter, requestId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.exec.get");
            e.printStackTrace();
        }
    }
}
String *dataid = dataid_example; // Name identifier of the data query.
String *currentLanguage = currentLanguage_example; // Current language, to get localized data query results.
String *role = role_example; // Role of the user to perform the action with. (optional)
String *refTag = refTag_example; // Reference name for the dashboard definition version. (optional)
map[String, String] *filter = ; // Filters to apply on the data query. (optional)
Converter *converter = ; // Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional)
String *requestId = requestId_example; // Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional)

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

// Execute data query
[apiInstance dataquery.exec.getWith:dataid
    currentLanguage:currentLanguage
    role:role
    refTag:refTag
    filter:filter
    converter:converter
    requestId:requestId
              completionHandler: ^(DataQueryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DseconnectRestApi = require('dseconnect_rest_api');

var api = new DseconnectRestApi.DataQueryApi()
var dataid = dataid_example; // {{String}} Name identifier of the data query.
var currentLanguage = currentLanguage_example; // {{String}} Current language, to get localized data query results.
var opts = { 
  'role': role_example, // {{String}} Role of the user to perform the action with.
  'refTag': refTag_example, // {{String}} Reference name for the dashboard definition version.
  'filter': , // {{map[String, String]}} Filters to apply on the data query.
  'converter': , // {{Converter}} Converter to set the orientation of the data query result. As default the value rowconverter is used.
  'requestId': requestId_example // {{String}} Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

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

namespace Example
{
    public class dataquery.exec.getExample
    {
        public void main()
        {

            var apiInstance = new DataQueryApi();
            var dataid = dataid_example;  // String | Name identifier of the data query.
            var currentLanguage = currentLanguage_example;  // String | Current language, to get localized data query results.
            var role = role_example;  // String | Role of the user to perform the action with. (optional) 
            var refTag = refTag_example;  // String | Reference name for the dashboard definition version. (optional) 
            var filter = new map[String, String](); // map[String, String] | Filters to apply on the data query. (optional) 
            var converter = new Converter(); // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional) 
            var requestId = requestId_example;  // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional) 

            try
            {
                // Execute data query
                DataQueryResult result = apiInstance.dataquery.exec.get(dataid, currentLanguage, role, refTag, filter, converter, requestId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataQueryApi.dataquery.exec.get: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataQueryApi();
$dataid = dataid_example; // String | Name identifier of the data query.
$currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
$role = role_example; // String | Role of the user to perform the action with.
$refTag = refTag_example; // String | Reference name for the dashboard definition version.
$filter = ; // map[String, String] | Filters to apply on the data query.
$converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
$requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.


try {
    $result = $api_instance->dataquery.exec.get($dataid, $currentLanguage, $role, $refTag, $filter, $converter, $requestId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataQueryApi->dataquery.exec.get: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataQueryApi;

my $api_instance = WWW::SwaggerClient::DataQueryApi->new();
my $dataid = dataid_example; # String | Name identifier of the data query.
my $currentLanguage = currentLanguage_example; # String | Current language, to get localized data query results.
my $role = role_example; # String | Role of the user to perform the action with.
my $refTag = refTag_example; # String | Reference name for the dashboard definition version.
my $filter = ; # map[String, String] | Filters to apply on the data query.
my $converter = ; # Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
my $requestId = requestId_example; # String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.


eval { 
    my $result = $api_instance->dataquery.exec.get(dataid => $dataid, currentLanguage => $currentLanguage, role => $role, refTag => $refTag, filter => $filter, converter => $converter, requestId => $requestId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataQueryApi->dataquery.exec.get: $@\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.DataQueryApi()
dataid = dataid_example # String | Name identifier of the data query.
currentLanguage = currentLanguage_example # String | Current language, to get localized data query results.
role = role_example # String | Role of the user to perform the action with. (optional)
refTag = refTag_example # String | Reference name for the dashboard definition version. (optional)
filter =  # map[String, String] | Filters to apply on the data query. (optional)
converter =  # Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional)
requestId = requestId_example # String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional)

try: 
    # Execute data query
    api_response = api_instance.dataquery/exec/get(dataid, currentLanguage, role=role, refTag=refTag, filter=filter, converter=converter, requestId=requestId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataQueryApi->dataquery.exec.get: %s\n" % e)

Parameters

Path parameters
Name Description
dataid*
String
Name identifier of the data query.
Required
Header parameters
Name Description
request-id
String
Request-id, reference to cancel this data query. Query ist not cancelable when not set.
Query parameters
Name Description
_role
String
Role of the user to perform the action with.
_refTag
String
Reference name for the dashboard definition version.
filter
map[String, String]
Filters to apply on the data query.
_converter
Converter
Converter to set the orientation of the data query result. As default the value rowconverter is used.
_currentLanguage*
String
Current language, to get localized data query results.
Required

Responses

Status: 200 - OK

Status: 400 - Bad request.

Status: 401 - Unauthorized.


dataquery.exec.post

Execute data query


/de.eoda.dse.portal.dataquery.rest/{dataid}/exec

Usage and SDK Samples

curl -X POST "http://example.com/backend//de.eoda.dse.portal.dataquery.rest/{dataid}/exec?_role=&_refTag=&filter=&_converter=&_currentLanguage="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataQueryApi;

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

public class DataQueryApiExample {

    public static void main(String[] args) {
        
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        map[String, String] body = "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n"; // map[String, String] | Request body to execute a data query
        String requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        map[String, String] filter = ; // map[String, String] | Filters to apply on the data query.
        Converter converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
        String currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.

        try {
            DataQueryResult result = apiInstance.dataquery.exec.post(dataid, body, requestId, role, refTag, filter, converter, currentLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.exec.post");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataQueryApi;

public class DataQueryApiExample {

    public static void main(String[] args) {
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        map[String, String] body = "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n"; // map[String, String] | Request body to execute a data query
        String requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        map[String, String] filter = ; // map[String, String] | Filters to apply on the data query.
        Converter converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
        String currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.

        try {
            DataQueryResult result = apiInstance.dataquery.exec.post(dataid, body, requestId, role, refTag, filter, converter, currentLanguage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.exec.post");
            e.printStackTrace();
        }
    }
}
String *dataid = dataid_example; // Name identifier of the data query.
map[String, String] *body = "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n"; // Request body to execute a data query (optional)
String *requestId = requestId_example; // Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional)
String *role = role_example; // Role of the user to perform the action with. (optional)
String *refTag = refTag_example; // Reference name for the dashboard definition version. (optional)
map[String, String] *filter = ; // Filters to apply on the data query. (optional)
Converter *converter = ; // Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional)
String *currentLanguage = currentLanguage_example; // Current language, to get localized data query results.
This Parameter is not needed when set in post request body.
 (optional)

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

// Execute data query
[apiInstance dataquery.exec.postWith:dataid
    body:body
    requestId:requestId
    role:role
    refTag:refTag
    filter:filter
    converter:converter
    currentLanguage:currentLanguage
              completionHandler: ^(DataQueryResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DseconnectRestApi = require('dseconnect_rest_api');

var api = new DseconnectRestApi.DataQueryApi()
var dataid = dataid_example; // {{String}} Name identifier of the data query.
var opts = { 
  'body': "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n" // {{map[String, String]}} Request body to execute a data query
  'requestId': requestId_example // {{String}} Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

  'role': role_example // {{String}} Role of the user to perform the action with.
  'refTag': refTag_example // {{String}} Reference name for the dashboard definition version.
  'filter':  // {{map[String, String]}} Filters to apply on the data query.
  'converter':  // {{Converter}} Converter to set the orientation of the data query result. As default the value rowconverter is used.
  'currentLanguage': currentLanguage_example // {{String}} Current language, to get localized data query results.
This Parameter is not needed when set in post request body.

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

namespace Example
{
    public class dataquery.exec.postExample
    {
        public void main()
        {

            var apiInstance = new DataQueryApi();
            var dataid = dataid_example;  // String | Name identifier of the data query.
            var body = new map[String, String](); // map[String, String] | Request body to execute a data query (optional) 
            var requestId = requestId_example;  // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional) 
            var role = role_example;  // String | Role of the user to perform the action with. (optional) 
            var refTag = refTag_example;  // String | Reference name for the dashboard definition version. (optional) 
            var filter = new map[String, String](); // map[String, String] | Filters to apply on the data query. (optional) 
            var converter = new Converter(); // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional) 
            var currentLanguage = currentLanguage_example;  // String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.
 (optional) 

            try
            {
                // Execute data query
                DataQueryResult result = apiInstance.dataquery.exec.post(dataid, body, requestId, role, refTag, filter, converter, currentLanguage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataQueryApi.dataquery.exec.post: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataQueryApi();
$dataid = dataid_example; // String | Name identifier of the data query.
$body = "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n"; // map[String, String] | Request body to execute a data query
$requestId = requestId_example; // String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

$role = role_example; // String | Role of the user to perform the action with.
$refTag = refTag_example; // String | Reference name for the dashboard definition version.
$filter = ; // map[String, String] | Filters to apply on the data query.
$converter = ; // Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
$currentLanguage = currentLanguage_example; // String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.


try {
    $result = $api_instance->dataquery.exec.post($dataid, $body, $requestId, $role, $refTag, $filter, $converter, $currentLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataQueryApi->dataquery.exec.post: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataQueryApi;

my $api_instance = WWW::SwaggerClient::DataQueryApi->new();
my $dataid = dataid_example; # String | Name identifier of the data query.
my $body = WWW::SwaggerClient::Object::map[String, String]->new(); # map[String, String] | Request body to execute a data query
my $requestId = requestId_example; # String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.

my $role = role_example; # String | Role of the user to perform the action with.
my $refTag = refTag_example; # String | Reference name for the dashboard definition version.
my $filter = ; # map[String, String] | Filters to apply on the data query.
my $converter = ; # Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used.
my $currentLanguage = currentLanguage_example; # String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.


eval { 
    my $result = $api_instance->dataquery.exec.post(dataid => $dataid, body => $body, requestId => $requestId, role => $role, refTag => $refTag, filter => $filter, converter => $converter, currentLanguage => $currentLanguage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataQueryApi->dataquery.exec.post: $@\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.DataQueryApi()
dataid = dataid_example # String | Name identifier of the data query.
body = "{\n  \"_role\": \"System_Admin\",\n  \"_currentLanguage\": \"de_DE\",\n  \"_refTag\": \"demo\",\n  \"_converter\": \"rowconverter\",\n  \"filter1\": \"07e6a59b4319f9a68729289851f955eb03be13fa3f4b86920a093a9902da1301\",\n  \"filter100\": \"5e0d2e60ac0b406a21b44474fdff9d08c2f5de65cd811f39dc1415ee1e9659f0\",\n  \"filter2000\": \"18c4b8e33979d34e5ff1ad2f1bbb57fdf9402ab927cd2401e1a4d3a205be3d72\"\n}\n" # map[String, String] | Request body to execute a data query (optional)
requestId = requestId_example # String | Request-id, reference to cancel this data query.
Query ist not cancelable when not set.
 (optional)
role = role_example # String | Role of the user to perform the action with. (optional)
refTag = refTag_example # String | Reference name for the dashboard definition version. (optional)
filter =  # map[String, String] | Filters to apply on the data query. (optional)
converter =  # Converter | Converter to set the orientation of the data query result. As default the value rowconverter is used. (optional)
currentLanguage = currentLanguage_example # String | Current language, to get localized data query results.
This Parameter is not needed when set in post request body.
 (optional)

try: 
    # Execute data query
    api_response = api_instance.dataquery/exec/post(dataid, body=body, requestId=requestId, role=role, refTag=refTag, filter=filter, converter=converter, currentLanguage=currentLanguage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataQueryApi->dataquery.exec.post: %s\n" % e)

Parameters

Path parameters
Name Description
dataid*
String
Name identifier of the data query.
Required
Header parameters
Name Description
request-id
String
Request-id, reference to cancel this data query. Query ist not cancelable when not set.
Body parameters
Name Description
body
Query parameters
Name Description
_role
String
Role of the user to perform the action with.
_refTag
String
Reference name for the dashboard definition version.
filter
map[String, String]
Filters to apply on the data query.
_converter
Converter
Converter to set the orientation of the data query result. As default the value rowconverter is used.
_currentLanguage
String
Current language, to get localized data query results. This Parameter is not needed when set in post request body.

Responses

Status: 200 - OK

Status: 400 - Bad request.

Status: 401 - Unauthorized.


dataquery.fetch

Fetch data query

Fetch a data query for a given data id, user role and reference tag


/de.eoda.dse.portal.dataquery.rest/{dataid}

Usage and SDK Samples

curl -X GET "http://example.com/backend//de.eoda.dse.portal.dataquery.rest/{dataid}?role=&refTag="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataQueryApi;

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

public class DataQueryApiExample {

    public static void main(String[] args) {
        
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        try {
            DataQuery result = apiInstance.dataquery.fetch(dataid, role, refTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.fetch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataQueryApi;

public class DataQueryApiExample {

    public static void main(String[] args) {
        DataQueryApi apiInstance = new DataQueryApi();
        String dataid = dataid_example; // String | Name identifier of the data query.
        String role = role_example; // String | Role of the user to perform the action with.
        String refTag = refTag_example; // String | Reference name for the dashboard definition version.
        try {
            DataQuery result = apiInstance.dataquery.fetch(dataid, role, refTag);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataQueryApi#dataquery.fetch");
            e.printStackTrace();
        }
    }
}
String *dataid = dataid_example; // Name identifier of the data query.
String *role = role_example; // Role of the user to perform the action with. (optional)
String *refTag = refTag_example; // Reference name for the dashboard definition version. (optional)

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

// Fetch data query
[apiInstance dataquery.fetchWith:dataid
    role:role
    refTag:refTag
              completionHandler: ^(DataQuery output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DseconnectRestApi = require('dseconnect_rest_api');

var api = new DseconnectRestApi.DataQueryApi()
var dataid = dataid_example; // {{String}} Name identifier of the data query.
var opts = { 
  'role': role_example, // {{String}} Role of the user to perform the action with.
  'refTag': refTag_example // {{String}} Reference name for the dashboard definition version.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dataquery.fetch(dataid, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class dataquery.fetchExample
    {
        public void main()
        {

            var apiInstance = new DataQueryApi();
            var dataid = dataid_example;  // String | Name identifier of the data query.
            var role = role_example;  // String | Role of the user to perform the action with. (optional) 
            var refTag = refTag_example;  // String | Reference name for the dashboard definition version. (optional) 

            try
            {
                // Fetch data query
                DataQuery result = apiInstance.dataquery.fetch(dataid, role, refTag);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataQueryApi.dataquery.fetch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDataQueryApi();
$dataid = dataid_example; // String | Name identifier of the data query.
$role = role_example; // String | Role of the user to perform the action with.
$refTag = refTag_example; // String | Reference name for the dashboard definition version.

try {
    $result = $api_instance->dataquery.fetch($dataid, $role, $refTag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataQueryApi->dataquery.fetch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataQueryApi;

my $api_instance = WWW::SwaggerClient::DataQueryApi->new();
my $dataid = dataid_example; # String | Name identifier of the data query.
my $role = role_example; # String | Role of the user to perform the action with.
my $refTag = refTag_example; # String | Reference name for the dashboard definition version.

eval { 
    my $result = $api_instance->dataquery.fetch(dataid => $dataid, role => $role, refTag => $refTag);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataQueryApi->dataquery.fetch: $@\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.DataQueryApi()
dataid = dataid_example # String | Name identifier of the data query.
role = role_example # String | Role of the user to perform the action with. (optional)
refTag = refTag_example # String | Reference name for the dashboard definition version. (optional)

try: 
    # Fetch data query
    api_response = api_instance.dataquery/fetch(dataid, role=role, refTag=refTag)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataQueryApi->dataquery.fetch: %s\n" % e)

Parameters

Path parameters
Name Description
dataid*
String
Name identifier of the data query.
Required
Query parameters
Name Description
role
String
Role of the user to perform the action with.
refTag
String
Reference name for the dashboard definition version.

Responses

Status: 200 - OK

Status: 401 - Unauthorized.

Status: 404 - Not found


TokenAuthentication

user.apitoken

Fetch user API token

Fetch a temporary valid API token of the actual user who is logged in. This token is for the login as the actual user with an external software.


/de.eoda.dse.portal.auth.apitoken.rest/

Usage and SDK Samples

curl -X POST "http://example.com/backend//de.eoda.dse.portal.auth.apitoken.rest/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TokenAuthenticationApi;

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

public class TokenAuthenticationApiExample {

    public static void main(String[] args) {
        
        TokenAuthenticationApi apiInstance = new TokenAuthenticationApi();
        try {
            'String' result = apiInstance.user.apitoken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenAuthenticationApi#user.apitoken");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TokenAuthenticationApi;

public class TokenAuthenticationApiExample {

    public static void main(String[] args) {
        TokenAuthenticationApi apiInstance = new TokenAuthenticationApi();
        try {
            'String' result = apiInstance.user.apitoken();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenAuthenticationApi#user.apitoken");
            e.printStackTrace();
        }
    }
}

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

// Fetch user API token
[apiInstance user.apitokenWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DseconnectRestApi = require('dseconnect_rest_api');

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

namespace Example
{
    public class user.apitokenExample
    {
        public void main()
        {

            var apiInstance = new TokenAuthenticationApi();

            try
            {
                // Fetch user API token
                'String' result = apiInstance.user.apitoken();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TokenAuthenticationApi.user.apitoken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTokenAuthenticationApi();

try {
    $result = $api_instance->user.apitoken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenAuthenticationApi->user.apitoken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TokenAuthenticationApi;

my $api_instance = WWW::SwaggerClient::TokenAuthenticationApi->new();

eval { 
    my $result = $api_instance->user.apitoken();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenAuthenticationApi->user.apitoken: $@\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.TokenAuthenticationApi()

try: 
    # Fetch user API token
    api_response = api_instance.user/apitoken()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenAuthenticationApi->user.apitoken: %s\n" % e)

Parameters

Responses

Status: 200 - A temporary valid API token (time to live ~300s)

Status: 401 - Not authenticated


users.login

User login with temporary API token

API which takes user API token to login the user.


/de.eoda.dse.portal.auth.apitoken.rest/login

Usage and SDK Samples

curl -X POST "http://example.com/backend//de.eoda.dse.portal.auth.apitoken.rest/login?token="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TokenAuthenticationApi;

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

public class TokenAuthenticationApiExample {

    public static void main(String[] args) {
        
        TokenAuthenticationApi apiInstance = new TokenAuthenticationApi();
        String token = token_example; // String | The temporary API token of the user.
        try {
            apiInstance.users.login(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenAuthenticationApi#users.login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TokenAuthenticationApi;

public class TokenAuthenticationApiExample {

    public static void main(String[] args) {
        TokenAuthenticationApi apiInstance = new TokenAuthenticationApi();
        String token = token_example; // String | The temporary API token of the user.
        try {
            apiInstance.users.login(token);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenAuthenticationApi#users.login");
            e.printStackTrace();
        }
    }
}
String *token = token_example; // The temporary API token of the user.

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

// User login with temporary API token
[apiInstance users.loginWith:token
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var DseconnectRestApi = require('dseconnect_rest_api');

var api = new DseconnectRestApi.TokenAuthenticationApi()
var token = token_example; // {{String}} The temporary API token of the user.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.users.login(token, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class users.loginExample
    {
        public void main()
        {

            var apiInstance = new TokenAuthenticationApi();
            var token = token_example;  // String | The temporary API token of the user.

            try
            {
                // User login with temporary API token
                apiInstance.users.login(token);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TokenAuthenticationApi.users.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTokenAuthenticationApi();
$token = token_example; // String | The temporary API token of the user.

try {
    $api_instance->users.login($token);
} catch (Exception $e) {
    echo 'Exception when calling TokenAuthenticationApi->users.login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TokenAuthenticationApi;

my $api_instance = WWW::SwaggerClient::TokenAuthenticationApi->new();
my $token = token_example; # String | The temporary API token of the user.

eval { 
    $api_instance->users.login(token => $token);
};
if ($@) {
    warn "Exception when calling TokenAuthenticationApi->users.login: $@\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.TokenAuthenticationApi()
token = token_example # String | The temporary API token of the user.

try: 
    # User login with temporary API token
    api_instance.users/login(token)
except ApiException as e:
    print("Exception when calling TokenAuthenticationApi->users.login: %s\n" % e)

Parameters

Query parameters
Name Description
token*
String
The temporary API token of the user.
Required

Responses

Status: 202 - Successful login.

Status: 400 - Bad Request. Token must not be null.

Status: 401 - Not authenticated. Token is missing or invalid.