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
|