Platform Admin API

BusinessProcessController

triggerEvent

Trigger business process event

Causes a trigger on a business process event


/businessprocess/events

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/adminapi/businessprocess/events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BusinessProcessControllerApi;

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

public class BusinessProcessControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        BusinessProcessControllerApi apiInstance = new BusinessProcessControllerApi();
        TriggerEventRequest body = ; // TriggerEventRequest | 
        try {
            TriggerEventResponse result = apiInstance.triggerEvent(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessProcessControllerApi#triggerEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BusinessProcessControllerApi;

public class BusinessProcessControllerApiExample {

    public static void main(String[] args) {
        BusinessProcessControllerApi apiInstance = new BusinessProcessControllerApi();
        TriggerEventRequest body = ; // TriggerEventRequest | 
        try {
            TriggerEventResponse result = apiInstance.triggerEvent(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BusinessProcessControllerApi#triggerEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
TriggerEventRequest *body = ; // 

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

// Trigger business process event
[apiInstance triggerEventWith:body
              completionHandler: ^(TriggerEventResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PlatformAdminApi = require('platform_admin_api');
var defaultClient = PlatformAdminApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PlatformAdminApi.BusinessProcessControllerApi()
var body = ; // {{TriggerEventRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.triggerEvent(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class triggerEventExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new BusinessProcessControllerApi();
            var body = new TriggerEventRequest(); // TriggerEventRequest | 

            try
            {
                // Trigger business process event
                TriggerEventResponse result = apiInstance.triggerEvent(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BusinessProcessControllerApi.triggerEvent: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiBusinessProcessControllerApi();
$body = ; // TriggerEventRequest | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::BusinessProcessControllerApi->new();
my $body = WWW::SwaggerClient::Object::TriggerEventRequest->new(); # TriggerEventRequest | 

eval { 
    my $result = $api_instance->triggerEvent(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BusinessProcessControllerApi->triggerEvent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.BusinessProcessControllerApi()
body =  # TriggerEventRequest | 

try: 
    # Trigger business process event
    api_response = api_instance.trigger_event(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BusinessProcessControllerApi->triggerEvent: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Operation succeeded

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - event can't be null

Status: 409 - Event has been already triggered

SearchController

executeFlexibleSearch

Execute flexible search

Runs a flexible search query


/console/search/flexible

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/adminapi/console/search/flexible?commit=&locale=&maxCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchControllerApi;

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

public class SearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Boolean commit = true; // Boolean | 
        String locale = locale_example; // String | 
        Integer maxCount = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executeFlexibleSearch(body, commit, locale, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executeFlexibleSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchControllerApi;

public class SearchControllerApiExample {

    public static void main(String[] args) {
        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Boolean commit = true; // Boolean | 
        String locale = locale_example; // String | 
        Integer maxCount = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executeFlexibleSearch(body, commit, locale, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executeFlexibleSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
QueryData *body = ; // 
Boolean *commit = true; //  (optional) (default to false)
String *locale = locale_example; //  (optional)
Integer *maxCount = 56; //  (optional) (default to 200)

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

// Execute flexible search
[apiInstance executeFlexibleSearchWith:body
    commit:commit
    locale:locale
    maxCount:maxCount
              completionHandler: ^(SearchResultData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PlatformAdminApi = require('platform_admin_api');
var defaultClient = PlatformAdminApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PlatformAdminApi.SearchControllerApi()
var body = ; // {{QueryData}} 
var opts = { 
  'commit': true // {{Boolean}} 
  'locale': locale_example // {{String}} 
  'maxCount': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeFlexibleSearch(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class executeFlexibleSearchExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SearchControllerApi();
            var body = new QueryData(); // QueryData | 
            var commit = true;  // Boolean |  (optional)  (default to false)
            var locale = locale_example;  // String |  (optional) 
            var maxCount = 56;  // Integer |  (optional)  (default to 200)

            try
            {
                // Execute flexible search
                SearchResultData result = apiInstance.executeFlexibleSearch(body, commit, locale, maxCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchControllerApi.executeFlexibleSearch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSearchControllerApi();
$body = ; // QueryData | 
$commit = true; // Boolean | 
$locale = locale_example; // String | 
$maxCount = 56; // Integer | 

try {
    $result = $api_instance->executeFlexibleSearch($body, $commit, $locale, $maxCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchControllerApi->executeFlexibleSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SearchControllerApi->new();
my $body = WWW::SwaggerClient::Object::QueryData->new(); # QueryData | 
my $commit = true; # Boolean | 
my $locale = locale_example; # String | 
my $maxCount = 56; # Integer | 

eval { 
    my $result = $api_instance->executeFlexibleSearch(body => $body, commit => $commit, locale => $locale, maxCount => $maxCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchControllerApi->executeFlexibleSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SearchControllerApi()
body =  # QueryData | 
commit = true # Boolean |  (optional) (default to false)
locale = locale_example # String |  (optional)
maxCount = 56 # Integer |  (optional) (default to 200)

try: 
    # Execute flexible search
    api_response = api_instance.execute_flexible_search(body, commit=commit, locale=locale, maxCount=maxCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchControllerApi->executeFlexibleSearch: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
commit
Boolean
locale
String
maxCount
Integer (int32)

Responses

Status: 200 - Operation succeeded

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - locale 'unknown' is not supported

executePolyglot

Execute polyglot query search

Runs a polyglot search query


/console/search/polyglot

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/adminapi/console/search/polyglot?count=&needTotalCount=&start="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchControllerApi;

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

public class SearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Integer count = 56; // Integer | 
        Boolean needTotalCount = true; // Boolean | 
        Integer start = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executePolyglot(body, count, needTotalCount, start);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executePolyglot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchControllerApi;

public class SearchControllerApiExample {

    public static void main(String[] args) {
        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Integer count = 56; // Integer | 
        Boolean needTotalCount = true; // Boolean | 
        Integer start = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executePolyglot(body, count, needTotalCount, start);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executePolyglot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
QueryData *body = ; // 
Integer *count = 56; //  (optional) (default to -1)
Boolean *needTotalCount = true; //  (optional) (default to false)
Integer *start = 56; //  (optional) (default to 0)

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

// Execute polyglot query search
[apiInstance executePolyglotWith:body
    count:count
    needTotalCount:needTotalCount
    start:start
              completionHandler: ^(SearchResultData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PlatformAdminApi = require('platform_admin_api');
var defaultClient = PlatformAdminApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PlatformAdminApi.SearchControllerApi()
var body = ; // {{QueryData}} 
var opts = { 
  'count': 56 // {{Integer}} 
  'needTotalCount': true // {{Boolean}} 
  'start': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executePolyglot(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class executePolyglotExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SearchControllerApi();
            var body = new QueryData(); // QueryData | 
            var count = 56;  // Integer |  (optional)  (default to -1)
            var needTotalCount = true;  // Boolean |  (optional)  (default to false)
            var start = 56;  // Integer |  (optional)  (default to 0)

            try
            {
                // Execute polyglot query search
                SearchResultData result = apiInstance.executePolyglot(body, count, needTotalCount, start);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchControllerApi.executePolyglot: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSearchControllerApi();
$body = ; // QueryData | 
$count = 56; // Integer | 
$needTotalCount = true; // Boolean | 
$start = 56; // Integer | 

try {
    $result = $api_instance->executePolyglot($body, $count, $needTotalCount, $start);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchControllerApi->executePolyglot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SearchControllerApi->new();
my $body = WWW::SwaggerClient::Object::QueryData->new(); # QueryData | 
my $count = 56; # Integer | 
my $needTotalCount = true; # Boolean | 
my $start = 56; # Integer | 

eval { 
    my $result = $api_instance->executePolyglot(body => $body, count => $count, needTotalCount => $needTotalCount, start => $start);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchControllerApi->executePolyglot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SearchControllerApi()
body =  # QueryData | 
count = 56 # Integer |  (optional) (default to -1)
needTotalCount = true # Boolean |  (optional) (default to false)
start = 56 # Integer |  (optional) (default to 0)

try: 
    # Execute polyglot query search
    api_response = api_instance.execute_polyglot(body, count=count, needTotalCount=needTotalCount, start=start)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchControllerApi->executePolyglot: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
count
Integer (int32)
needTotalCount
Boolean
start
Integer (int32)

Responses

Status: 200 - Operation succeeded

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found

Status: 409 - locale 'unknown' is not supported

executeSqlQuery

Execute sql search

Runs a sql query search


/console/search/sql

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"http://localhost:9001/adminapi/console/search/sql?commit=&maxCount="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchControllerApi;

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

public class SearchControllerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Boolean commit = true; // Boolean | 
        Integer maxCount = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executeSqlQuery(body, commit, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executeSqlQuery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchControllerApi;

public class SearchControllerApiExample {

    public static void main(String[] args) {
        SearchControllerApi apiInstance = new SearchControllerApi();
        QueryData body = ; // QueryData | 
        Boolean commit = true; // Boolean | 
        Integer maxCount = 56; // Integer | 
        try {
            SearchResultData result = apiInstance.executeSqlQuery(body, commit, maxCount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchControllerApi#executeSqlQuery");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
QueryData *body = ; // 
Boolean *commit = true; //  (optional) (default to false)
Integer *maxCount = 56; //  (optional) (default to 200)

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

// Execute sql search
[apiInstance executeSqlQueryWith:body
    commit:commit
    maxCount:maxCount
              completionHandler: ^(SearchResultData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PlatformAdminApi = require('platform_admin_api');
var defaultClient = PlatformAdminApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PlatformAdminApi.SearchControllerApi()
var body = ; // {{QueryData}} 
var opts = { 
  'commit': true // {{Boolean}} 
  'maxCount': 56 // {{Integer}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeSqlQuery(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class executeSqlQueryExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SearchControllerApi();
            var body = new QueryData(); // QueryData | 
            var commit = true;  // Boolean |  (optional)  (default to false)
            var maxCount = 56;  // Integer |  (optional)  (default to 200)

            try
            {
                // Execute sql search
                SearchResultData result = apiInstance.executeSqlQuery(body, commit, maxCount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchControllerApi.executeSqlQuery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiSearchControllerApi();
$body = ; // QueryData | 
$commit = true; // Boolean | 
$maxCount = 56; // Integer | 

try {
    $result = $api_instance->executeSqlQuery($body, $commit, $maxCount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchControllerApi->executeSqlQuery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchControllerApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::SearchControllerApi->new();
my $body = WWW::SwaggerClient::Object::QueryData->new(); # QueryData | 
my $commit = true; # Boolean | 
my $maxCount = 56; # Integer | 

eval { 
    my $result = $api_instance->executeSqlQuery(body => $body, commit => $commit, maxCount => $maxCount);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchControllerApi->executeSqlQuery: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.SearchControllerApi()
body =  # QueryData | 
commit = true # Boolean |  (optional) (default to false)
maxCount = 56 # Integer |  (optional) (default to 200)

try: 
    # Execute sql search
    api_response = api_instance.execute_sql_query(body, commit=commit, maxCount=maxCount)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchControllerApi->executeSqlQuery: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
commit
Boolean
maxCount
Integer (int32)

Responses

Status: 200 - Operation succeeded

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found