AICA API

AICA

getProtocolVersion

API Protocol Version

Get the API protocol version


/protocol

Usage and SDK Samples

curl -X GET "https://localhost/api/protocol"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AICAApi;

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

public class AICAApiExample {

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

public class AICAApiExample {

    public static void main(String[] args) {
        AICAApi apiInstance = new AICAApi();
        try {
            apiInstance.getProtocolVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling AICAApi#getProtocolVersion");
            e.printStackTrace();
        }
    }
}

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

// API Protocol Version
[apiInstance getProtocolVersionWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');

var api = new AicaApi.AICAApi()

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

namespace Example
{
    public class getProtocolVersionExample
    {
        public void main()
        {
            
            var apiInstance = new AICAApi();

            try
            {
                // API Protocol Version
                apiInstance.getProtocolVersion();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AICAApi.getProtocolVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AICAApi();

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

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

eval { 
    $api_instance->getProtocolVersion();
};
if ($@) {
    warn "Exception when calling AICAApi->getProtocolVersion: $@\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.AICAApi()

try: 
    # API Protocol Version
    api_instance.get_protocol_version()
except ApiException as e:
    print("Exception when calling AICAApi->getProtocolVersion: %s\n" % e)

Parameters

Responses

Status: 200 - Success


getVersion

Get the version of AICA Core

This endpoint may be temporarily unavailable while the core backend is starting up, or if the core image is not an officially signed version (as may be in the case of a pre-release or development build)


/version

Usage and SDK Samples

curl -X GET "https://localhost/api/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AICAApi;

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

public class AICAApiExample {

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

public class AICAApiExample {

    public static void main(String[] args) {
        AICAApi apiInstance = new AICAApi();
        try {
            apiInstance.getVersion();
        } catch (ApiException e) {
            System.err.println("Exception when calling AICAApi#getVersion");
            e.printStackTrace();
        }
    }
}

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

// Get the version of AICA Core
[apiInstance getVersionWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');

var api = new AicaApi.AICAApi()

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

namespace Example
{
    public class getVersionExample
    {
        public void main()
        {
            
            var apiInstance = new AICAApi();

            try
            {
                // Get the version of AICA Core
                apiInstance.getVersion();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AICAApi.getVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AICAApi();

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

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

eval { 
    $api_instance->getVersion();
};
if ($@) {
    warn "Exception when calling AICAApi->getVersion: $@\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.AICAApi()

try: 
    # Get the version of AICA Core
    api_instance.get_version()
except ApiException as e:
    print("Exception when calling AICAApi->getVersion: %s\n" % e)

Parameters

Responses

Status: 404 - Core version not found

Status: 200 - Core version


Applications

callControllerService

Call a service on a component


/v2/application/hardware/{hardware_name}/controller/{controller_name}/service/{service_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}/controller/{controller_name}/service/{service_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String serviceName = serviceName_example; // String | The name of the service
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_2 payload = ; // Payload_2 | 
        try {
            apiInstance.callControllerService(serviceName, controllerName, hardwareName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#callControllerService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String serviceName = serviceName_example; // String | The name of the service
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_2 payload = ; // Payload_2 | 
        try {
            apiInstance.callControllerService(serviceName, controllerName, hardwareName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#callControllerService");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *serviceName = serviceName_example; // The name of the service
String *controllerName = controllerName_example; // The name of the controller
String *hardwareName = hardwareName_example; // The name of the hardware
Payload_2 *payload = ; // 

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

// Call a service on a component
[apiInstance callControllerServiceWith:serviceName
    controllerName:controllerName
    hardwareName:hardwareName
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var serviceName = serviceName_example; // {String} The name of the service

var controllerName = controllerName_example; // {String} The name of the controller

var hardwareName = hardwareName_example; // {String} The name of the hardware

var payload = ; // {Payload_2} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.callControllerService(serviceName, controllerName, hardwareName, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class callControllerServiceExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var serviceName = serviceName_example;  // String | The name of the service
            var controllerName = controllerName_example;  // String | The name of the controller
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var payload = new Payload_2(); // Payload_2 | 

            try
            {
                // Call a service on a component
                apiInstance.callControllerService(serviceName, controllerName, hardwareName, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.callControllerService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$serviceName = serviceName_example; // String | The name of the service
$controllerName = controllerName_example; // String | The name of the controller
$hardwareName = hardwareName_example; // String | The name of the hardware
$payload = ; // Payload_2 | 

try {
    $api_instance->callControllerService($serviceName, $controllerName, $hardwareName, $payload);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->callControllerService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $serviceName = serviceName_example; # String | The name of the service
my $controllerName = controllerName_example; # String | The name of the controller
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $payload = WWW::SwaggerClient::Object::Payload_2->new(); # Payload_2 | 

eval { 
    $api_instance->callControllerService(serviceName => $serviceName, controllerName => $controllerName, hardwareName => $hardwareName, payload => $payload);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->callControllerService: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
serviceName = serviceName_example # String | The name of the service
controllerName = controllerName_example # String | The name of the controller
hardwareName = hardwareName_example # String | The name of the hardware
payload =  # Payload_2 | 

try: 
    # Call a service on a component
    api_instance.call_controller_service(serviceName, controllerName, hardwareName, payload)
except ApiException as e:
    print("Exception when calling ApplicationsApi->callControllerService: %s\n" % e)

Parameters

Path parameters
Name Description
service_name*
String
The name of the service
Required
controller_name*
String
The name of the controller
Required
hardware_name*
String
The name of the hardware
Required
Body parameters
Name Description
payload *

Responses

Status: 400 - The service request is invalid

Status: 202 - The service request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


callService

Call a service on a component


/v2/application/components/{component_name}/service/{service_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/components/{component_name}/service/{service_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String serviceName = serviceName_example; // String | The name of the service
        String componentName = componentName_example; // String | The name of the component
        Payload_1 payload = ; // Payload_1 | 
        try {
            apiInstance.callService(serviceName, componentName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#callService");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String serviceName = serviceName_example; // String | The name of the service
        String componentName = componentName_example; // String | The name of the component
        Payload_1 payload = ; // Payload_1 | 
        try {
            apiInstance.callService(serviceName, componentName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#callService");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *serviceName = serviceName_example; // The name of the service
String *componentName = componentName_example; // The name of the component
Payload_1 *payload = ; // 

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

// Call a service on a component
[apiInstance callServiceWith:serviceName
    componentName:componentName
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var serviceName = serviceName_example; // {String} The name of the service

var componentName = componentName_example; // {String} The name of the component

var payload = ; // {Payload_1} 


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

namespace Example
{
    public class callServiceExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var serviceName = serviceName_example;  // String | The name of the service
            var componentName = componentName_example;  // String | The name of the component
            var payload = new Payload_1(); // Payload_1 | 

            try
            {
                // Call a service on a component
                apiInstance.callService(serviceName, componentName, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.callService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$serviceName = serviceName_example; // String | The name of the service
$componentName = componentName_example; // String | The name of the component
$payload = ; // Payload_1 | 

try {
    $api_instance->callService($serviceName, $componentName, $payload);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->callService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $serviceName = serviceName_example; # String | The name of the service
my $componentName = componentName_example; # String | The name of the component
my $payload = WWW::SwaggerClient::Object::Payload_1->new(); # Payload_1 | 

eval { 
    $api_instance->callService(serviceName => $serviceName, componentName => $componentName, payload => $payload);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->callService: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
serviceName = serviceName_example # String | The name of the service
componentName = componentName_example # String | The name of the component
payload =  # Payload_1 | 

try: 
    # Call a service on a component
    api_instance.call_service(serviceName, componentName, payload)
except ApiException as e:
    print("Exception when calling ApplicationsApi->callService: %s\n" % e)

Parameters

Path parameters
Name Description
service_name*
String
The name of the service
Required
component_name*
String
The name of the component
Required
Body parameters
Name Description
payload *

Responses

Status: 400 - The service request is invalid

Status: 202 - The service request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


getApplication

Get the current application


/v2/application

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getApplication();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getApplication();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the current application
[apiInstance getApplicationWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

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

namespace Example
{
    public class getApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();

            try
            {
                // Get the current application
                apiInstance.getApplication();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

eval { 
    $api_instance->getApplication();
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()

try: 
    # Get the current application
    api_instance.get_application()
except ApiException as e:
    print("Exception when calling ApplicationsApi->getApplication: %s\n" % e)

Parameters

Responses

Status: 400 - The application is invalid or not set

Status: 200 - Returns application YAML content

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getApplicationState

Get the application state


/v2/application/state

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/state"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getApplicationState();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getApplicationState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        try {
            apiInstance.getApplicationState();
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#getApplicationState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Get the application state
[apiInstance getApplicationStateWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

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

namespace Example
{
    public class getApplicationStateExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();

            try
            {
                // Get the application state
                apiInstance.getApplicationState();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.getApplicationState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

eval { 
    $api_instance->getApplicationState();
};
if ($@) {
    warn "Exception when calling ApplicationsApi->getApplicationState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()

try: 
    # Get the application state
    api_instance.get_application_state()
except ApiException as e:
    print("Exception when calling ApplicationsApi->getApplicationState: %s\n" % e)

Parameters

Responses

Status: 200 - Returns the application state

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


loadComponent

Load a component


/v2/application/components/{component_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/components/{component_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        try {
            apiInstance.loadComponent(componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        try {
            apiInstance.loadComponent(componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadComponent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *componentName = componentName_example; // The name of the component

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

// Load a component
[apiInstance loadComponentWith:componentName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var componentName = componentName_example; // {String} The name of the component


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

namespace Example
{
    public class loadComponentExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var componentName = componentName_example;  // String | The name of the component

            try
            {
                // Load a component
                apiInstance.loadComponent(componentName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.loadComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$componentName = componentName_example; // String | The name of the component

try {
    $api_instance->loadComponent($componentName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->loadComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $componentName = componentName_example; # String | The name of the component

eval { 
    $api_instance->loadComponent(componentName => $componentName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->loadComponent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
componentName = componentName_example # String | The name of the component

try: 
    # Load a component
    api_instance.load_component(componentName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->loadComponent: %s\n" % e)

Parameters

Path parameters
Name Description
component_name*
String
The name of the component
Required

Responses

Status: 400 - The load request is invalid

Status: 202 - The load request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


loadController

Load a controller


/v2/application/hardware/{hardware_name}/controller/{controller_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}/controller/{controller_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.loadController(controllerName, hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadController");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.loadController(controllerName, hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadController");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *controllerName = controllerName_example; // The name of the controller
String *hardwareName = hardwareName_example; // The name of the hardware

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

// Load a controller
[apiInstance loadControllerWith:controllerName
    hardwareName:hardwareName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var controllerName = controllerName_example; // {String} The name of the controller

var hardwareName = hardwareName_example; // {String} The name of the hardware


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

namespace Example
{
    public class loadControllerExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var controllerName = controllerName_example;  // String | The name of the controller
            var hardwareName = hardwareName_example;  // String | The name of the hardware

            try
            {
                // Load a controller
                apiInstance.loadController(controllerName, hardwareName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.loadController: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$controllerName = controllerName_example; // String | The name of the controller
$hardwareName = hardwareName_example; // String | The name of the hardware

try {
    $api_instance->loadController($controllerName, $hardwareName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->loadController: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $controllerName = controllerName_example; # String | The name of the controller
my $hardwareName = hardwareName_example; # String | The name of the hardware

eval { 
    $api_instance->loadController(controllerName => $controllerName, hardwareName => $hardwareName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->loadController: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
controllerName = controllerName_example # String | The name of the controller
hardwareName = hardwareName_example # String | The name of the hardware

try: 
    # Load a controller
    api_instance.load_controller(controllerName, hardwareName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->loadController: %s\n" % e)

Parameters

Path parameters
Name Description
controller_name*
String
The name of the controller
Required
hardware_name*
String
The name of the hardware
Required

Responses

Status: 400 - The load request is invalid

Status: 202 - The load request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


loadHardware

Load a hardware interface


/v2/application/hardware/{hardware_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.loadHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.loadHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#loadHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware

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

// Load a hardware interface
[apiInstance loadHardwareWith:hardwareName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware


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

namespace Example
{
    public class loadHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware

            try
            {
                // Load a hardware interface
                apiInstance.loadHardware(hardwareName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.loadHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$hardwareName = hardwareName_example; // String | The name of the hardware

try {
    $api_instance->loadHardware($hardwareName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->loadHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware

eval { 
    $api_instance->loadHardware(hardwareName => $hardwareName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->loadHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
hardwareName = hardwareName_example # String | The name of the hardware

try: 
    # Load a hardware interface
    api_instance.load_hardware(hardwareName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->loadHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required

Responses

Status: 400 - The load request is invalid

Status: 202 - The load request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


manageSequence

Manage a sequence


/v2/application/sequences/{sequence_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/sequences/{sequence_name}?action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String sequenceName = sequenceName_example; // String | The name of the sequence
        String action = action_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.manageSequence(sequenceName, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#manageSequence");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String sequenceName = sequenceName_example; // String | The name of the sequence
        String action = action_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.manageSequence(sequenceName, action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#manageSequence");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *sequenceName = sequenceName_example; // The name of the sequence
String *action = action_example; // Bad choice: {error_msg}

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

// Manage a sequence
[apiInstance manageSequenceWith:sequenceName
    action:action
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var sequenceName = sequenceName_example; // {String} The name of the sequence

var action = action_example; // {String} Bad choice: {error_msg}


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

namespace Example
{
    public class manageSequenceExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var sequenceName = sequenceName_example;  // String | The name of the sequence
            var action = action_example;  // String | Bad choice: {error_msg}

            try
            {
                // Manage a sequence
                apiInstance.manageSequence(sequenceName, action);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.manageSequence: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$sequenceName = sequenceName_example; // String | The name of the sequence
$action = action_example; // String | Bad choice: {error_msg}

try {
    $api_instance->manageSequence($sequenceName, $action);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->manageSequence: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $sequenceName = sequenceName_example; # String | The name of the sequence
my $action = action_example; # String | Bad choice: {error_msg}

eval { 
    $api_instance->manageSequence(sequenceName => $sequenceName, action => $action);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->manageSequence: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
sequenceName = sequenceName_example # String | The name of the sequence
action = action_example # String | Bad choice: {error_msg}

try: 
    # Manage a sequence
    api_instance.manage_sequence(sequenceName, action)
except ApiException as e:
    print("Exception when calling ApplicationsApi->manageSequence: %s\n" % e)

Parameters

Path parameters
Name Description
sequence_name*
String
The name of the sequence
Required
Query parameters
Name Description
action*
String
Bad choice: {error_msg}
Required

Responses

Status: 400 - The sequence management request could not be executed

Status: 204 - The sequence management request was successful

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


setApplication

Set the application


/v2/application

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        Payload payload = ; // Payload | 
        try {
            apiInstance.setApplication(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        Payload payload = ; // Payload | 
        try {
            apiInstance.setApplication(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Payload *payload = ; // 

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

// Set the application
[apiInstance setApplicationWith:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var payload = ; // {Payload} 


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

namespace Example
{
    public class setApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var payload = new Payload(); // Payload | 

            try
            {
                // Set the application
                apiInstance.setApplication(payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.setApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$payload = ; // Payload | 

try {
    $api_instance->setApplication($payload);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->setApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $payload = WWW::SwaggerClient::Object::Payload->new(); # Payload | 

eval { 
    $api_instance->setApplication(payload => $payload);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->setApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
payload =  # Payload | 

try: 
    # Set the application
    api_instance.set_application(payload)
except ApiException as e:
    print("Exception when calling ApplicationsApi->setApplication: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 400 - The application could not be set

Status: 204 - The application was set successfully

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


setApplicationTransition

Set an application state transition


/v2/application/state/transition

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/state/transition?action="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String action = action_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.setApplicationTransition(action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setApplicationTransition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String action = action_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.setApplicationTransition(action);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setApplicationTransition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *action = action_example; // Bad choice: {error_msg}

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

// Set an application state transition
[apiInstance setApplicationTransitionWith:action
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var action = action_example; // {String} Bad choice: {error_msg}


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

namespace Example
{
    public class setApplicationTransitionExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var action = action_example;  // String | Bad choice: {error_msg}

            try
            {
                // Set an application state transition
                apiInstance.setApplicationTransition(action);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.setApplicationTransition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$action = action_example; // String | Bad choice: {error_msg}

try {
    $api_instance->setApplicationTransition($action);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->setApplicationTransition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $action = action_example; # String | Bad choice: {error_msg}

eval { 
    $api_instance->setApplicationTransition(action => $action);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->setApplicationTransition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
action = action_example # String | Bad choice: {error_msg}

try: 
    # Set an application state transition
    api_instance.set_application_transition(action)
except ApiException as e:
    print("Exception when calling ApplicationsApi->setApplicationTransition: %s\n" % e)

Parameters

Query parameters
Name Description
action*
String
Bad choice: {error_msg}
Required

Responses

Status: 400 - The application state transition could not be executed

Status: 204 - The application state transition was successful

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


setControllerParameter

Set a parameter on a controller


/v2/application/hardware/{hardware_name}/controller/{controller_name}/parameter/{parameter_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}/controller/{controller_name}/parameter/{parameter_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String parameterName = parameterName_example; // String | The name of the parameter
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Parameter_value payload = ; // Parameter_value | 
        try {
            apiInstance.setControllerParameter(parameterName, controllerName, hardwareName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setControllerParameter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String parameterName = parameterName_example; // String | The name of the parameter
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Parameter_value payload = ; // Parameter_value | 
        try {
            apiInstance.setControllerParameter(parameterName, controllerName, hardwareName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setControllerParameter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *parameterName = parameterName_example; // The name of the parameter
String *controllerName = controllerName_example; // The name of the controller
String *hardwareName = hardwareName_example; // The name of the hardware
Parameter_value *payload = ; // 

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

// Set a parameter on a controller
[apiInstance setControllerParameterWith:parameterName
    controllerName:controllerName
    hardwareName:hardwareName
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var parameterName = parameterName_example; // {String} The name of the parameter

var controllerName = controllerName_example; // {String} The name of the controller

var hardwareName = hardwareName_example; // {String} The name of the hardware

var payload = ; // {Parameter_value} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setControllerParameter(parameterName, controllerName, hardwareName, payload, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class setControllerParameterExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var parameterName = parameterName_example;  // String | The name of the parameter
            var controllerName = controllerName_example;  // String | The name of the controller
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var payload = new Parameter_value(); // Parameter_value | 

            try
            {
                // Set a parameter on a controller
                apiInstance.setControllerParameter(parameterName, controllerName, hardwareName, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.setControllerParameter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$parameterName = parameterName_example; // String | The name of the parameter
$controllerName = controllerName_example; // String | The name of the controller
$hardwareName = hardwareName_example; // String | The name of the hardware
$payload = ; // Parameter_value | 

try {
    $api_instance->setControllerParameter($parameterName, $controllerName, $hardwareName, $payload);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->setControllerParameter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $parameterName = parameterName_example; # String | The name of the parameter
my $controllerName = controllerName_example; # String | The name of the controller
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $payload = WWW::SwaggerClient::Object::Parameter_value->new(); # Parameter_value | 

eval { 
    $api_instance->setControllerParameter(parameterName => $parameterName, controllerName => $controllerName, hardwareName => $hardwareName, payload => $payload);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->setControllerParameter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
parameterName = parameterName_example # String | The name of the parameter
controllerName = controllerName_example # String | The name of the controller
hardwareName = hardwareName_example # String | The name of the hardware
payload =  # Parameter_value | 

try: 
    # Set a parameter on a controller
    api_instance.set_controller_parameter(parameterName, controllerName, hardwareName, payload)
except ApiException as e:
    print("Exception when calling ApplicationsApi->setControllerParameter: %s\n" % e)

Parameters

Path parameters
Name Description
parameter_name*
String
The name of the parameter
Required
controller_name*
String
The name of the controller
Required
hardware_name*
String
The name of the hardware
Required
Body parameters
Name Description
payload *

Responses

Status: 400 - The parameter change request is invalid

Status: 202 - The parameter change request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


setLifecycleTransition

Set a lifecycle transition on a component


/v2/application/components/{component_name}/lifecycle/transition

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/components/{component_name}/lifecycle/transition?transition="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        String transition = transition_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.setLifecycleTransition(componentName, transition);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setLifecycleTransition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        String transition = transition_example; // String | Bad choice: {error_msg}
        try {
            apiInstance.setLifecycleTransition(componentName, transition);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setLifecycleTransition");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *componentName = componentName_example; // The name of the component
String *transition = transition_example; // Bad choice: {error_msg}

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

// Set a lifecycle transition on a component
[apiInstance setLifecycleTransitionWith:componentName
    transition:transition
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var componentName = componentName_example; // {String} The name of the component

var transition = transition_example; // {String} Bad choice: {error_msg}


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

namespace Example
{
    public class setLifecycleTransitionExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var componentName = componentName_example;  // String | The name of the component
            var transition = transition_example;  // String | Bad choice: {error_msg}

            try
            {
                // Set a lifecycle transition on a component
                apiInstance.setLifecycleTransition(componentName, transition);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.setLifecycleTransition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$componentName = componentName_example; // String | The name of the component
$transition = transition_example; // String | Bad choice: {error_msg}

try {
    $api_instance->setLifecycleTransition($componentName, $transition);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->setLifecycleTransition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $componentName = componentName_example; # String | The name of the component
my $transition = transition_example; # String | Bad choice: {error_msg}

eval { 
    $api_instance->setLifecycleTransition(componentName => $componentName, transition => $transition);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->setLifecycleTransition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
componentName = componentName_example # String | The name of the component
transition = transition_example # String | Bad choice: {error_msg}

try: 
    # Set a lifecycle transition on a component
    api_instance.set_lifecycle_transition(componentName, transition)
except ApiException as e:
    print("Exception when calling ApplicationsApi->setLifecycleTransition: %s\n" % e)

Parameters

Path parameters
Name Description
component_name*
String
The name of the component
Required
Query parameters
Name Description
transition*
String
Bad choice: {error_msg}
Required

Responses

Status: 400 - The lifecycle transition request is invalid

Status: 202 - The lifecycle transition request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


setParameter

Set a parameter on a component


/v2/application/components/{component_name}/parameter/{parameter_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/components/{component_name}/parameter/{parameter_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String parameterName = parameterName_example; // String | The name of the parameter
        String componentName = componentName_example; // String | The name of the component
        Parameter_value payload = ; // Parameter_value | 
        try {
            apiInstance.setParameter(parameterName, componentName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setParameter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String parameterName = parameterName_example; // String | The name of the parameter
        String componentName = componentName_example; // String | The name of the component
        Parameter_value payload = ; // Parameter_value | 
        try {
            apiInstance.setParameter(parameterName, componentName, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#setParameter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *parameterName = parameterName_example; // The name of the parameter
String *componentName = componentName_example; // The name of the component
Parameter_value *payload = ; // 

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

// Set a parameter on a component
[apiInstance setParameterWith:parameterName
    componentName:componentName
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var parameterName = parameterName_example; // {String} The name of the parameter

var componentName = componentName_example; // {String} The name of the component

var payload = ; // {Parameter_value} 


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

namespace Example
{
    public class setParameterExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var parameterName = parameterName_example;  // String | The name of the parameter
            var componentName = componentName_example;  // String | The name of the component
            var payload = new Parameter_value(); // Parameter_value | 

            try
            {
                // Set a parameter on a component
                apiInstance.setParameter(parameterName, componentName, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.setParameter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$parameterName = parameterName_example; // String | The name of the parameter
$componentName = componentName_example; // String | The name of the component
$payload = ; // Parameter_value | 

try {
    $api_instance->setParameter($parameterName, $componentName, $payload);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->setParameter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $parameterName = parameterName_example; # String | The name of the parameter
my $componentName = componentName_example; # String | The name of the component
my $payload = WWW::SwaggerClient::Object::Parameter_value->new(); # Parameter_value | 

eval { 
    $api_instance->setParameter(parameterName => $parameterName, componentName => $componentName, payload => $payload);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->setParameter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
parameterName = parameterName_example # String | The name of the parameter
componentName = componentName_example # String | The name of the component
payload =  # Parameter_value | 

try: 
    # Set a parameter on a component
    api_instance.set_parameter(parameterName, componentName, payload)
except ApiException as e:
    print("Exception when calling ApplicationsApi->setParameter: %s\n" % e)

Parameters

Path parameters
Name Description
parameter_name*
String
The name of the parameter
Required
component_name*
String
The name of the component
Required
Body parameters
Name Description
payload *

Responses

Status: 400 - The parameter change request is invalid

Status: 202 - The parameter change request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


switchControllers

Switch one or several controllers


/v2/application/hardware/{hardware_name}/controllers

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}/controllers?activate=&deactivate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        array[String] activate = ; // array[String] | Expected the name of a controller to be activated ({error_msg})
        array[String] deactivate = ; // array[String] | Expected the name of a controller to be deactivated ({error_msg})
        try {
            apiInstance.switchControllers(hardwareName, activate, deactivate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#switchControllers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        array[String] activate = ; // array[String] | Expected the name of a controller to be activated ({error_msg})
        array[String] deactivate = ; // array[String] | Expected the name of a controller to be deactivated ({error_msg})
        try {
            apiInstance.switchControllers(hardwareName, activate, deactivate);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#switchControllers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware
array[String] *activate = ; // Expected the name of a controller to be activated ({error_msg}) (optional) (default to [])
array[String] *deactivate = ; // Expected the name of a controller to be deactivated ({error_msg}) (optional) (default to [])

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

// Switch one or several controllers
[apiInstance switchControllersWith:hardwareName
    activate:activate
    deactivate:deactivate
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware

var opts = { 
  'activate': , // {array[String]} Expected the name of a controller to be activated ({error_msg})
  'deactivate':  // {array[String]} Expected the name of a controller to be deactivated ({error_msg})
};

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

namespace Example
{
    public class switchControllersExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var activate = new array[String](); // array[String] | Expected the name of a controller to be activated ({error_msg}) (optional)  (default to [])
            var deactivate = new array[String](); // array[String] | Expected the name of a controller to be deactivated ({error_msg}) (optional)  (default to [])

            try
            {
                // Switch one or several controllers
                apiInstance.switchControllers(hardwareName, activate, deactivate);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.switchControllers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$hardwareName = hardwareName_example; // String | The name of the hardware
$activate = ; // array[String] | Expected the name of a controller to be activated ({error_msg})
$deactivate = ; // array[String] | Expected the name of a controller to be deactivated ({error_msg})

try {
    $api_instance->switchControllers($hardwareName, $activate, $deactivate);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->switchControllers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $activate = []; # array[String] | Expected the name of a controller to be activated ({error_msg})
my $deactivate = []; # array[String] | Expected the name of a controller to be deactivated ({error_msg})

eval { 
    $api_instance->switchControllers(hardwareName => $hardwareName, activate => $activate, deactivate => $deactivate);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->switchControllers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
hardwareName = hardwareName_example # String | The name of the hardware
activate =  # array[String] | Expected the name of a controller to be activated ({error_msg}) (optional) (default to [])
deactivate =  # array[String] | Expected the name of a controller to be deactivated ({error_msg}) (optional) (default to [])

try: 
    # Switch one or several controllers
    api_instance.switch_controllers(hardwareName, activate=activate, deactivate=deactivate)
except ApiException as e:
    print("Exception when calling ApplicationsApi->switchControllers: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required
Query parameters
Name Description
activate
array[String]
Expected the name of a controller to be activated ({error_msg})
deactivate
array[String]
Expected the name of a controller to be deactivated ({error_msg})

Responses

Status: 400 - The switch controllers request is invalid

Status: 202 - The switch controllers request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


unloadComponent

Unload a component


/v2/application/components/{component_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/components/{component_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        try {
            apiInstance.unloadComponent(componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String componentName = componentName_example; // String | The name of the component
        try {
            apiInstance.unloadComponent(componentName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadComponent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *componentName = componentName_example; // The name of the component

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

// Unload a component
[apiInstance unloadComponentWith:componentName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var componentName = componentName_example; // {String} The name of the component


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

namespace Example
{
    public class unloadComponentExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var componentName = componentName_example;  // String | The name of the component

            try
            {
                // Unload a component
                apiInstance.unloadComponent(componentName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.unloadComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$componentName = componentName_example; // String | The name of the component

try {
    $api_instance->unloadComponent($componentName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->unloadComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $componentName = componentName_example; # String | The name of the component

eval { 
    $api_instance->unloadComponent(componentName => $componentName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->unloadComponent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
componentName = componentName_example # String | The name of the component

try: 
    # Unload a component
    api_instance.unload_component(componentName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->unloadComponent: %s\n" % e)

Parameters

Path parameters
Name Description
component_name*
String
The name of the component
Required

Responses

Status: 400 - The unload request is invalid

Status: 202 - The unload request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


unloadController

Unload a controller


/v2/application/hardware/{hardware_name}/controller/{controller_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}/controller/{controller_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.unloadController(controllerName, hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadController");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String controllerName = controllerName_example; // String | The name of the controller
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.unloadController(controllerName, hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadController");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *controllerName = controllerName_example; // The name of the controller
String *hardwareName = hardwareName_example; // The name of the hardware

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

// Unload a controller
[apiInstance unloadControllerWith:controllerName
    hardwareName:hardwareName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var controllerName = controllerName_example; // {String} The name of the controller

var hardwareName = hardwareName_example; // {String} The name of the hardware


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

namespace Example
{
    public class unloadControllerExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var controllerName = controllerName_example;  // String | The name of the controller
            var hardwareName = hardwareName_example;  // String | The name of the hardware

            try
            {
                // Unload a controller
                apiInstance.unloadController(controllerName, hardwareName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.unloadController: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$controllerName = controllerName_example; // String | The name of the controller
$hardwareName = hardwareName_example; // String | The name of the hardware

try {
    $api_instance->unloadController($controllerName, $hardwareName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->unloadController: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $controllerName = controllerName_example; # String | The name of the controller
my $hardwareName = hardwareName_example; # String | The name of the hardware

eval { 
    $api_instance->unloadController(controllerName => $controllerName, hardwareName => $hardwareName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->unloadController: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
controllerName = controllerName_example # String | The name of the controller
hardwareName = hardwareName_example # String | The name of the hardware

try: 
    # Unload a controller
    api_instance.unload_controller(controllerName, hardwareName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->unloadController: %s\n" % e)

Parameters

Path parameters
Name Description
controller_name*
String
The name of the controller
Required
hardware_name*
String
The name of the hardware
Required

Responses

Status: 400 - The unload request is invalid

Status: 202 - The unload request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


unloadHardware

Unload a hardware interface


/v2/application/hardware/{hardware_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/application/hardware/{hardware_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationsApi;

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

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.unloadHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationsApi;

public class ApplicationsApiExample {

    public static void main(String[] args) {
        ApplicationsApi apiInstance = new ApplicationsApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.unloadHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationsApi#unloadHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware

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

// Unload a hardware interface
[apiInstance unloadHardwareWith:hardwareName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ApplicationsApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware


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

namespace Example
{
    public class unloadHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApplicationsApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware

            try
            {
                // Unload a hardware interface
                apiInstance.unloadHardware(hardwareName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationsApi.unloadHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ApplicationsApi();
$hardwareName = hardwareName_example; // String | The name of the hardware

try {
    $api_instance->unloadHardware($hardwareName);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationsApi->unloadHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationsApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApplicationsApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware

eval { 
    $api_instance->unloadHardware(hardwareName => $hardwareName);
};
if ($@) {
    warn "Exception when calling ApplicationsApi->unloadHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ApplicationsApi()
hardwareName = hardwareName_example # String | The name of the hardware

try: 
    # Unload a hardware interface
    api_instance.unload_hardware(hardwareName)
except ApiException as e:
    print("Exception when calling ApplicationsApi->unloadHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required

Responses

Status: 400 - The unload request is invalid

Status: 202 - The unload request is accepted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


Auth

login

Login user, returning an opaque token


/v2/auth/login

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://localhost/api/v2/auth/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        // Configure HTTP basic authorization: userPassword
        HttpBasicAuth userPassword = (HttpBasicAuth) defaultClient.getAuthentication("userPassword");
        userPassword.setUsername("YOUR USERNAME");
        userPassword.setPassword("YOUR PASSWORD");

        AuthApi apiInstance = new AuthApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            LoginToken result = apiInstance.login(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthApi;

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            LoginToken result = apiInstance.login(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#login");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
// Configure HTTP basic authorization (authentication scheme: userPassword)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Login user, returning an opaque token
[apiInstance loginWith:xFields
              completionHandler: ^(LoginToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['Authorization'] = "Token"

// Configure HTTP basic authorization: userPassword
var userPassword = defaultClient.authentications['userPassword'];
userPassword.username = 'YOUR USERNAME'
userPassword.password = 'YOUR PASSWORD'

var api = new AicaApi.AuthApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            
            // Configure API key authorization: apiKey
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure HTTP basic authorization: userPassword
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new AuthApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Login user, returning an opaque token
                LoginToken result = apiInstance.login(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
// Configure HTTP basic authorization: userPassword
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\AuthApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: apiKey
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";
# Configure HTTP basic authorization: userPassword
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::AuthApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: apiKey
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'
# Configure HTTP basic authorization: userPassword
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.AuthApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Login user, returning an opaque token
    api_response = api_instance.login(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->login: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 401 - Missing or invalid authentication


logout

Logout user, invalidating the provided token


/v2/auth/logout

Usage and SDK Samples

curl -X DELETE "https://localhost/api/v2/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthApi;

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

public class AuthApiExample {

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

public class AuthApiExample {

    public static void main(String[] args) {
        AuthApi apiInstance = new AuthApi();
        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthApi#logout");
            e.printStackTrace();
        }
    }
}

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

// Logout user, invalidating the provided token
[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');

var api = new AicaApi.AuthApi()

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

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            
            var apiInstance = new AuthApi();

            try
            {
                // Logout user, invalidating the provided token
                apiInstance.logout();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\AuthApi();

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

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

eval { 
    $api_instance->logout();
};
if ($@) {
    warn "Exception when calling AuthApi->logout: $@\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.AuthApi()

try: 
    # Logout user, invalidating the provided token
    api_instance.logout()
except ApiException as e:
    print("Exception when calling AuthApi->logout: %s\n" % e)

Parameters

Responses

Status: 401 - Missing or invalid authentication


Cloud

completeCloudAuth

Complete the Cloud OAuth authorization process, redirects to the Front-End


/v2/cloud/auth/complete

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/cloud/auth/complete?ver=&success=&error=&access_token=&refresh_token=&scopes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudApi;

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

public class CloudApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CloudApi apiInstance = new CloudApi();
        String ver = ver_example; // String | The formatting version (expected to be 1 at the moment)
        String success = success_example; // String | Whether the authorization was successful
        String error = error_example; // String | The error message (present on failure)
        String accessToken = accessToken_example; // String | The access token (present on success)
        String refreshToken = refreshToken_example; // String | The refresh token (present on success)
        String scopes = scopes_example; // String | The scopes granted (present on success)
        try {
            apiInstance.completeCloudAuth(ver, success, error, accessToken, refreshToken, scopes);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#completeCloudAuth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudApi;

public class CloudApiExample {

    public static void main(String[] args) {
        CloudApi apiInstance = new CloudApi();
        String ver = ver_example; // String | The formatting version (expected to be 1 at the moment)
        String success = success_example; // String | Whether the authorization was successful
        String error = error_example; // String | The error message (present on failure)
        String accessToken = accessToken_example; // String | The access token (present on success)
        String refreshToken = refreshToken_example; // String | The refresh token (present on success)
        String scopes = scopes_example; // String | The scopes granted (present on success)
        try {
            apiInstance.completeCloudAuth(ver, success, error, accessToken, refreshToken, scopes);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#completeCloudAuth");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *ver = ver_example; // The formatting version (expected to be 1 at the moment)
String *success = success_example; // Whether the authorization was successful
String *error = error_example; // The error message (present on failure) (optional)
String *accessToken = accessToken_example; // The access token (present on success) (optional)
String *refreshToken = refreshToken_example; // The refresh token (present on success) (optional)
String *scopes = scopes_example; // The scopes granted (present on success) (optional)

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

// Complete the Cloud OAuth authorization process, redirects to the Front-End
[apiInstance completeCloudAuthWith:ver
    success:success
    error:error
    accessToken:accessToken
    refreshToken:refreshToken
    scopes:scopes
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.CloudApi()

var ver = ver_example; // {String} The formatting version (expected to be 1 at the moment)

var success = success_example; // {String} Whether the authorization was successful

var opts = { 
  'error': error_example, // {String} The error message (present on failure)
  'accessToken': accessToken_example, // {String} The access token (present on success)
  'refreshToken': refreshToken_example, // {String} The refresh token (present on success)
  'scopes': scopes_example // {String} The scopes granted (present on success)
};

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

namespace Example
{
    public class completeCloudAuthExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudApi();
            var ver = ver_example;  // String | The formatting version (expected to be 1 at the moment)
            var success = success_example;  // String | Whether the authorization was successful
            var error = error_example;  // String | The error message (present on failure) (optional) 
            var accessToken = accessToken_example;  // String | The access token (present on success) (optional) 
            var refreshToken = refreshToken_example;  // String | The refresh token (present on success) (optional) 
            var scopes = scopes_example;  // String | The scopes granted (present on success) (optional) 

            try
            {
                // Complete the Cloud OAuth authorization process, redirects to the Front-End
                apiInstance.completeCloudAuth(ver, success, error, accessToken, refreshToken, scopes);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudApi.completeCloudAuth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CloudApi();
$ver = ver_example; // String | The formatting version (expected to be 1 at the moment)
$success = success_example; // String | Whether the authorization was successful
$error = error_example; // String | The error message (present on failure)
$accessToken = accessToken_example; // String | The access token (present on success)
$refreshToken = refreshToken_example; // String | The refresh token (present on success)
$scopes = scopes_example; // String | The scopes granted (present on success)

try {
    $api_instance->completeCloudAuth($ver, $success, $error, $accessToken, $refreshToken, $scopes);
} catch (Exception $e) {
    echo 'Exception when calling CloudApi->completeCloudAuth: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CloudApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CloudApi->new();
my $ver = ver_example; # String | The formatting version (expected to be 1 at the moment)
my $success = success_example; # String | Whether the authorization was successful
my $error = error_example; # String | The error message (present on failure)
my $accessToken = accessToken_example; # String | The access token (present on success)
my $refreshToken = refreshToken_example; # String | The refresh token (present on success)
my $scopes = scopes_example; # String | The scopes granted (present on success)

eval { 
    $api_instance->completeCloudAuth(ver => $ver, success => $success, error => $error, accessToken => $accessToken, refreshToken => $refreshToken, scopes => $scopes);
};
if ($@) {
    warn "Exception when calling CloudApi->completeCloudAuth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CloudApi()
ver = ver_example # String | The formatting version (expected to be 1 at the moment)
success = success_example # String | Whether the authorization was successful
error = error_example # String | The error message (present on failure) (optional)
accessToken = accessToken_example # String | The access token (present on success) (optional)
refreshToken = refreshToken_example # String | The refresh token (present on success) (optional)
scopes = scopes_example # String | The scopes granted (present on success) (optional)

try: 
    # Complete the Cloud OAuth authorization process, redirects to the Front-End
    api_instance.complete_cloud_auth(ver, success, error=error, accessToken=accessToken, refreshToken=refreshToken, scopes=scopes)
except ApiException as e:
    print("Exception when calling CloudApi->completeCloudAuth: %s\n" % e)

Parameters

Query parameters
Name Description
ver*
String
The formatting version (expected to be 1 at the moment)
Required
success*
String
Whether the authorization was successful
Required
error
String
The error message (present on failure)
access_token
String
The access token (present on success)
refresh_token
String
The refresh token (present on success)
scopes
String
The scopes granted (present on success)

Responses

Status: 400 - Invalid version or authorization failed

Status: 302 - Redirect to the Front-End

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


getCloudStatus

Return the Cloud authorization status


/v2/cloud/status

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/cloud/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudApi;

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

public class CloudApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CloudApi apiInstance = new CloudApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Cloud%20Status result = apiInstance.getCloudStatus(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#getCloudStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudApi;

public class CloudApiExample {

    public static void main(String[] args) {
        CloudApi apiInstance = new CloudApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Cloud%20Status result = apiInstance.getCloudStatus(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#getCloudStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Return the Cloud authorization status
[apiInstance getCloudStatusWith:xFields
              completionHandler: ^(Cloud%20Status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.CloudApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getCloudStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Return the Cloud authorization status
                Cloud%20Status result = apiInstance.getCloudStatus(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudApi.getCloudStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CloudApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CloudApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CloudApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Return the Cloud authorization status
    api_response = api_instance.get_cloud_status(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CloudApi->getCloudStatus: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


startCloudAuth

Redirect to the Cloud OAuth authorization page


/v2/cloud/auth/start

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/cloud/auth/start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudApi;

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

public class CloudApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CloudApi apiInstance = new CloudApi();
        try {
            apiInstance.startCloudAuth();
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#startCloudAuth");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudApi;

public class CloudApiExample {

    public static void main(String[] args) {
        CloudApi apiInstance = new CloudApi();
        try {
            apiInstance.startCloudAuth();
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#startCloudAuth");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Redirect to the Cloud OAuth authorization page
[apiInstance startCloudAuthWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.CloudApi()

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

namespace Example
{
    public class startCloudAuthExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudApi();

            try
            {
                // Redirect to the Cloud OAuth authorization page
                apiInstance.startCloudAuth();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudApi.startCloudAuth: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CloudApi();

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

eval { 
    $api_instance->startCloudAuth();
};
if ($@) {
    warn "Exception when calling CloudApi->startCloudAuth: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CloudApi()

try: 
    # Redirect to the Cloud OAuth authorization page
    api_instance.start_cloud_auth()
except ApiException as e:
    print("Exception when calling CloudApi->startCloudAuth: %s\n" % e)

Parameters

Responses

Status: 302 - Redirect to Cloud OAuth authorization page

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


syncCloudApps

Synchronize the Cloud applications with the local database


/v2/cloud/applications/sync

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/cloud/applications/sync"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CloudApi;

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

public class CloudApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        CloudApi apiInstance = new CloudApi();
        try {
            apiInstance.syncCloudApps();
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#syncCloudApps");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CloudApi;

public class CloudApiExample {

    public static void main(String[] args) {
        CloudApi apiInstance = new CloudApi();
        try {
            apiInstance.syncCloudApps();
        } catch (ApiException e) {
            System.err.println("Exception when calling CloudApi#syncCloudApps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Synchronize the Cloud applications with the local database
[apiInstance syncCloudAppsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.CloudApi()

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

namespace Example
{
    public class syncCloudAppsExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CloudApi();

            try
            {
                // Synchronize the Cloud applications with the local database
                apiInstance.syncCloudApps();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CloudApi.syncCloudApps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\CloudApi();

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

eval { 
    $api_instance->syncCloudApps();
};
if ($@) {
    warn "Exception when calling CloudApi->syncCloudApps: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CloudApi()

try: 
    # Synchronize the Cloud applications with the local database
    api_instance.sync_cloud_apps()
except ApiException as e:
    print("Exception when calling CloudApi->syncCloudApps: %s\n" % e)

Parameters

Responses

Status: 401 - Missing or invalid authentication

Status: 204 - Apps synchronized

Status: 403 - Missing one of the required scopes: control


Data

deleteDBApplication

Delete application from the database


/v2/data/applications/{application_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.deleteDBApplication(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteDBApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.deleteDBApplication(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteDBApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application

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

// Delete application from the database
[apiInstance deleteDBApplicationWith:applicationName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application


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

namespace Example
{
    public class deleteDBApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application

            try
            {
                // Delete application from the database
                apiInstance.deleteDBApplication(applicationName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.deleteDBApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application

try {
    $api_instance->deleteDBApplication($applicationName);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->deleteDBApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application

eval { 
    $api_instance->deleteDBApplication(applicationName => $applicationName);
};
if ($@) {
    warn "Exception when calling DataApi->deleteDBApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application

try: 
    # Delete application from the database
    api_instance.delete_db_application(applicationName)
except ApiException as e:
    print("Exception when calling DataApi->deleteDBApplication: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required

Responses

Status: 404 - Application not found

Status: 204 - Application deleted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


deleteDBHardware

Delete hardware from the database


/v2/data/hardware/{hardware_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/hardware/{hardware_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.deleteDBHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteDBHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        try {
            apiInstance.deleteDBHardware(hardwareName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#deleteDBHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware

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

// Delete hardware from the database
[apiInstance deleteDBHardwareWith:hardwareName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware


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

namespace Example
{
    public class deleteDBHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware

            try
            {
                // Delete hardware from the database
                apiInstance.deleteDBHardware(hardwareName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.deleteDBHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$hardwareName = hardwareName_example; // String | The name of the hardware

try {
    $api_instance->deleteDBHardware($hardwareName);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->deleteDBHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware

eval { 
    $api_instance->deleteDBHardware(hardwareName => $hardwareName);
};
if ($@) {
    warn "Exception when calling DataApi->deleteDBHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
hardwareName = hardwareName_example # String | The name of the hardware

try: 
    # Delete hardware from the database
    api_instance.delete_db_hardware(hardwareName)
except ApiException as e:
    print("Exception when calling DataApi->deleteDBHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required

Responses

Status: 404 - Hardware not found

Status: 204 - Hardware deleted

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


getDBApplication

Get application info


/v2/data/applications/{application_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.getDBApplication(applicationName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.getDBApplication(applicationName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get application info
[apiInstance getDBApplicationWith:applicationName
    xFields:xFields
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getDBApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get application info
                Application result = apiInstance.getDBApplication(applicationName, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDBApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get application info
    api_response = api_instance.get_db_application(applicationName, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDBApplication: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 404 - Application not found

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getDBApplicationList

List available applications from the database


/v2/data/applications

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Application] result = apiInstance.getDBApplicationList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBApplicationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Application] result = apiInstance.getDBApplicationList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBApplicationList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// List available applications from the database
[apiInstance getDBApplicationListWith:xFields
              completionHandler: ^(array[Application] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getDBApplicationListExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // List available applications from the database
                array[Application] result = apiInstance.getDBApplicationList(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDBApplicationList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # List available applications from the database
    api_response = api_instance.get_db_application_list(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDBApplicationList: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getDBHardware

Get hardware info


/v2/data/hardware/{hardware_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/hardware/{hardware_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.getDBHardware(hardwareName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.getDBHardware(hardwareName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get hardware info
[apiInstance getDBHardwareWith:hardwareName
    xFields:xFields
              completionHandler: ^(Hardware output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getDBHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get hardware info
                Hardware result = apiInstance.getDBHardware(hardwareName, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDBHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$hardwareName = hardwareName_example; // String | The name of the hardware
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
hardwareName = hardwareName_example # String | The name of the hardware
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get hardware info
    api_response = api_instance.get_db_hardware(hardwareName, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDBHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 404 - Hardware not found

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getDBHardwareList

List available hardware from the database


/v2/data/hardware

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/hardware"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Hardware] result = apiInstance.getDBHardwareList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBHardwareList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Hardware] result = apiInstance.getDBHardwareList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDBHardwareList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// List available hardware from the database
[apiInstance getDBHardwareListWith:xFields
              completionHandler: ^(array[Hardware] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getDBHardwareListExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // List available hardware from the database
                array[Hardware] result = apiInstance.getDBHardwareList(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDBHardwareList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # List available hardware from the database
    api_response = api_instance.get_db_hardware_list(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getDBHardwareList: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


patchDBApplication

Update application info


/v2/data/applications/{application_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        Payload_4 payload = ; // Payload_4 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.patchDBApplication(applicationName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#patchDBApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        Payload_4 payload = ; // Payload_4 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.patchDBApplication(applicationName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#patchDBApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application
Payload_4 *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Update application info
[apiInstance patchDBApplicationWith:applicationName
    payload:payload
    xFields:xFields
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application

var payload = ; // {Payload_4} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class patchDBApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application
            var payload = new Payload_4(); // Payload_4 | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Update application info
                Application result = apiInstance.patchDBApplication(applicationName, payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.patchDBApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application
$payload = ; // Payload_4 | 
$xFields = xFields_example; // String | An optional fields mask

try {
    $result = $api_instance->patchDBApplication($applicationName, $payload, $xFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->patchDBApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application
my $payload = WWW::SwaggerClient::Object::Payload_4->new(); # Payload_4 | 
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    my $result = $api_instance->patchDBApplication(applicationName => $applicationName, payload => $payload, xFields => $xFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->patchDBApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application
payload =  # Payload_4 | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Update application info
    api_response = api_instance.patch_db_application(applicationName, payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->patchDBApplication: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 404 - Application not found

Status: 304 - Application not modified

Status: 200 - Success

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


patchDBHardware

Update hardware info


/v2/data/hardware/{hardware_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/hardware/{hardware_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_6 payload = ; // Payload_6 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.patchDBHardware(hardwareName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#patchDBHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_6 payload = ; // Payload_6 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.patchDBHardware(hardwareName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#patchDBHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware
Payload_6 *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Update hardware info
[apiInstance patchDBHardwareWith:hardwareName
    payload:payload
    xFields:xFields
              completionHandler: ^(Hardware output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware

var payload = ; // {Payload_6} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class patchDBHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var payload = new Payload_6(); // Payload_6 | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Update hardware info
                Hardware result = apiInstance.patchDBHardware(hardwareName, payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.patchDBHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$hardwareName = hardwareName_example; // String | The name of the hardware
$payload = ; // Payload_6 | 
$xFields = xFields_example; // String | An optional fields mask

try {
    $result = $api_instance->patchDBHardware($hardwareName, $payload, $xFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->patchDBHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $payload = WWW::SwaggerClient::Object::Payload_6->new(); # Payload_6 | 
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    my $result = $api_instance->patchDBHardware(hardwareName => $hardwareName, payload => $payload, xFields => $xFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->patchDBHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
hardwareName = hardwareName_example # String | The name of the hardware
payload =  # Payload_6 | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Update hardware info
    api_response = api_instance.patch_db_hardware(hardwareName, payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->patchDBHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 404 - Hardware not found

Status: 304 - Hardware not modified

Status: 200 - Success

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


putDBApplication

Add application to the database


/v2/data/applications/{application_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        Payload_3 payload = ; // Payload_3 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.putDBApplication(applicationName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#putDBApplication");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        Payload_3 payload = ; // Payload_3 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Application result = apiInstance.putDBApplication(applicationName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#putDBApplication");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application
Payload_3 *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Add application to the database
[apiInstance putDBApplicationWith:applicationName
    payload:payload
    xFields:xFields
              completionHandler: ^(Application output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application

var payload = ; // {Payload_3} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class putDBApplicationExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application
            var payload = new Payload_3(); // Payload_3 | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Add application to the database
                Application result = apiInstance.putDBApplication(applicationName, payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.putDBApplication: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application
$payload = ; // Payload_3 | 
$xFields = xFields_example; // String | An optional fields mask

try {
    $result = $api_instance->putDBApplication($applicationName, $payload, $xFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->putDBApplication: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application
my $payload = WWW::SwaggerClient::Object::Payload_3->new(); # Payload_3 | 
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    my $result = $api_instance->putDBApplication(applicationName => $applicationName, payload => $payload, xFields => $xFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->putDBApplication: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application
payload =  # Payload_3 | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Add application to the database
    api_response = api_instance.put_db_application(applicationName, payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->putDBApplication: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 409 - Application with that name already exists

Status: 201 - Success

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


putDBHardware

Add hardware to the database


/v2/data/hardware/{hardware_name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/hardware/{hardware_name}"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_5 payload = ; // Payload_5 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.putDBHardware(hardwareName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#putDBHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        Payload_5 payload = ; // Payload_5 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.putDBHardware(hardwareName, payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#putDBHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware
Payload_5 *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Add hardware to the database
[apiInstance putDBHardwareWith:hardwareName
    payload:payload
    xFields:xFields
              completionHandler: ^(Hardware output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware

var payload = ; // {Payload_5} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class putDBHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var payload = new Payload_5(); // Payload_5 | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Add hardware to the database
                Hardware result = apiInstance.putDBHardware(hardwareName, payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.putDBHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$hardwareName = hardwareName_example; // String | The name of the hardware
$payload = ; // Payload_5 | 
$xFields = xFields_example; // String | An optional fields mask

try {
    $result = $api_instance->putDBHardware($hardwareName, $payload, $xFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->putDBHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $payload = WWW::SwaggerClient::Object::Payload_5->new(); # Payload_5 | 
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    my $result = $api_instance->putDBHardware(hardwareName => $hardwareName, payload => $payload, xFields => $xFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->putDBHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
hardwareName = hardwareName_example # String | The name of the hardware
payload =  # Payload_5 | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Add hardware to the database
    api_response = api_instance.put_db_hardware(hardwareName, payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->putDBHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 409 - Hardware with that name already exists

Status: 201 - Success

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


removeDBApplicationFromCloud

Remove application from the cloud


/v2/data/applications/{application_name}/cloud

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}/cloud"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.removeDBApplicationFromCloud(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#removeDBApplicationFromCloud");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.removeDBApplicationFromCloud(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#removeDBApplicationFromCloud");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application

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

// Remove application from the cloud
[apiInstance removeDBApplicationFromCloudWith:applicationName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application


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

namespace Example
{
    public class removeDBApplicationFromCloudExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application

            try
            {
                // Remove application from the cloud
                apiInstance.removeDBApplicationFromCloud(applicationName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.removeDBApplicationFromCloud: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application

try {
    $api_instance->removeDBApplicationFromCloud($applicationName);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->removeDBApplicationFromCloud: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application

eval { 
    $api_instance->removeDBApplicationFromCloud(applicationName => $applicationName);
};
if ($@) {
    warn "Exception when calling DataApi->removeDBApplicationFromCloud: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application

try: 
    # Remove application from the cloud
    api_instance.remove_db_application_from_cloud(applicationName)
except ApiException as e:
    print("Exception when calling DataApi->removeDBApplicationFromCloud: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required

Responses

Status: 404 - Application not found

Status: 400 - Application is not in the cloud

Status: 204 - Application removed from cloud

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


uploadDBApplicationToCloud

Upload application to the cloud


/v2/data/applications/{application_name}/cloud

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/data/applications/{application_name}/cloud"
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.uploadDBApplicationToCloud(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#uploadDBApplicationToCloud");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        String applicationName = applicationName_example; // String | The name of the application
        try {
            apiInstance.uploadDBApplicationToCloud(applicationName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#uploadDBApplicationToCloud");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *applicationName = applicationName_example; // The name of the application

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

// Upload application to the cloud
[apiInstance uploadDBApplicationToCloudWith:applicationName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.DataApi()

var applicationName = applicationName_example; // {String} The name of the application


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

namespace Example
{
    public class uploadDBApplicationToCloudExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var applicationName = applicationName_example;  // String | The name of the application

            try
            {
                // Upload application to the cloud
                apiInstance.uploadDBApplicationToCloud(applicationName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.uploadDBApplicationToCloud: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\DataApi();
$applicationName = applicationName_example; // String | The name of the application

try {
    $api_instance->uploadDBApplicationToCloud($applicationName);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->uploadDBApplicationToCloud: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $applicationName = applicationName_example; # String | The name of the application

eval { 
    $api_instance->uploadDBApplicationToCloud(applicationName => $applicationName);
};
if ($@) {
    warn "Exception when calling DataApi->uploadDBApplicationToCloud: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DataApi()
applicationName = applicationName_example # String | The name of the application

try: 
    # Upload application to the cloud
    api_instance.upload_db_application_to_cloud(applicationName)
except ApiException as e:
    print("Exception when calling DataApi->uploadDBApplicationToCloud: %s\n" % e)

Parameters

Path parameters
Name Description
application_name*
String
The name of the application
Required

Responses

Status: 404 - Application not found

Status: 400 - Application is already in the cloud

Status: 204 - Application uploaded to cloud

Status: 403 - Missing one of the required scopes: control

Status: 401 - Missing or invalid authentication


Examples

getExampleHardware

Get the hardware info of a filesystem example


/v2/examples/hardware/{hardware_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/examples/hardware/{hardware_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExamplesApi;

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

public class ExamplesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExamplesApi apiInstance = new ExamplesApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.getExampleHardware(hardwareName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExamplesApi#getExampleHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExamplesApi;

public class ExamplesApiExample {

    public static void main(String[] args) {
        ExamplesApi apiInstance = new ExamplesApi();
        String hardwareName = hardwareName_example; // String | The name of the hardware
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Hardware result = apiInstance.getExampleHardware(hardwareName, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExamplesApi#getExampleHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *hardwareName = hardwareName_example; // The name of the hardware
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get the hardware info of a filesystem example
[apiInstance getExampleHardwareWith:hardwareName
    xFields:xFields
              completionHandler: ^(Hardware output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ExamplesApi()

var hardwareName = hardwareName_example; // {String} The name of the hardware

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getExampleHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExamplesApi();
            var hardwareName = hardwareName_example;  // String | The name of the hardware
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get the hardware info of a filesystem example
                Hardware result = apiInstance.getExampleHardware(hardwareName, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExamplesApi.getExampleHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ExamplesApi();
$hardwareName = hardwareName_example; // String | The name of the hardware
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExamplesApi->new();
my $hardwareName = hardwareName_example; # String | The name of the hardware
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExamplesApi()
hardwareName = hardwareName_example # String | The name of the hardware
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get the hardware info of a filesystem example
    api_response = api_instance.get_example_hardware(hardwareName, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExamplesApi->getExampleHardware: %s\n" % e)

Parameters

Path parameters
Name Description
hardware_name*
String
The name of the hardware
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 404 - Hardware not found

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getExampleHardwareList

List available hardware from the filesystem examples


/v2/examples/hardware

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/examples/hardware"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExamplesApi;

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

public class ExamplesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ExamplesApi apiInstance = new ExamplesApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Hardware] result = apiInstance.getExampleHardwareList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExamplesApi#getExampleHardwareList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExamplesApi;

public class ExamplesApiExample {

    public static void main(String[] args) {
        ExamplesApi apiInstance = new ExamplesApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            array[Hardware] result = apiInstance.getExampleHardwareList(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExamplesApi#getExampleHardwareList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// List available hardware from the filesystem examples
[apiInstance getExampleHardwareListWith:xFields
              completionHandler: ^(array[Hardware] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ExamplesApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getExampleHardwareListExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ExamplesApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // List available hardware from the filesystem examples
                array[Hardware] result = apiInstance.getExampleHardwareList(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExamplesApi.getExampleHardwareList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ExamplesApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExamplesApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExamplesApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # List available hardware from the filesystem examples
    api_response = api_instance.get_example_hardware_list(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExamplesApi->getExampleHardwareList: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


ROS2

getAllTransforms

Lookup all transform from the TF buffer


/v2/ros/transforms

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/ros/transforms"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ROS2Api;

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

public class ROS2ApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ROS2Api apiInstance = new ROS2Api();
        try {
            apiInstance.getAllTransforms();
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#getAllTransforms");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ROS2Api;

public class ROS2ApiExample {

    public static void main(String[] args) {
        ROS2Api apiInstance = new ROS2Api();
        try {
            apiInstance.getAllTransforms();
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#getAllTransforms");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


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

// Lookup all transform from the TF buffer
[apiInstance getAllTransformsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ROS2Api()

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

namespace Example
{
    public class getAllTransformsExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ROS2Api();

            try
            {
                // Lookup all transform from the TF buffer
                apiInstance.getAllTransforms();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ROS2Api.getAllTransforms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ROS2Api();

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

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

eval { 
    $api_instance->getAllTransforms();
};
if ($@) {
    warn "Exception when calling ROS2Api->getAllTransforms: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ROS2Api()

try: 
    # Lookup all transform from the TF buffer
    api_instance.get_all_transforms()
except ApiException as e:
    print("Exception when calling ROS2Api->getAllTransforms: %s\n" % e)

Parameters

Responses

Status: 404 - Transforms not found

Status: 200 - Transforms found

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getTransform

Lookup a transform from the TF buffer


/v2/ros/transforms/{frame}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/ros/transforms/{frame}?reference_frame="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ROS2Api;

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

public class ROS2ApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ROS2Api apiInstance = new ROS2Api();
        String frame = frame_example; // String | The name of the frame to look up
        String referenceFrame = referenceFrame_example; // String | The reference frame
        String xFields = xFields_example; // String | An optional fields mask
        try {
            apiInstance.getTransform(frame, referenceFrame, xFields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#getTransform");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ROS2Api;

public class ROS2ApiExample {

    public static void main(String[] args) {
        ROS2Api apiInstance = new ROS2Api();
        String frame = frame_example; // String | The name of the frame to look up
        String referenceFrame = referenceFrame_example; // String | The reference frame
        String xFields = xFields_example; // String | An optional fields mask
        try {
            apiInstance.getTransform(frame, referenceFrame, xFields);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#getTransform");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *frame = frame_example; // The name of the frame to look up
String *referenceFrame = referenceFrame_example; // The reference frame (optional) (default to world)
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Lookup a transform from the TF buffer
[apiInstance getTransformWith:frame
    referenceFrame:referenceFrame
    xFields:xFields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ROS2Api()

var frame = frame_example; // {String} The name of the frame to look up

var opts = { 
  'referenceFrame': referenceFrame_example, // {String} The reference frame
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getTransformExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ROS2Api();
            var frame = frame_example;  // String | The name of the frame to look up
            var referenceFrame = referenceFrame_example;  // String | The reference frame (optional)  (default to world)
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Lookup a transform from the TF buffer
                apiInstance.getTransform(frame, referenceFrame, xFields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ROS2Api.getTransform: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ROS2Api();
$frame = frame_example; // String | The name of the frame to look up
$referenceFrame = referenceFrame_example; // String | The reference frame
$xFields = xFields_example; // String | An optional fields mask

try {
    $api_instance->getTransform($frame, $referenceFrame, $xFields);
} catch (Exception $e) {
    echo 'Exception when calling ROS2Api->getTransform: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ROS2Api;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ROS2Api->new();
my $frame = frame_example; # String | The name of the frame to look up
my $referenceFrame = referenceFrame_example; # String | The reference frame
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    $api_instance->getTransform(frame => $frame, referenceFrame => $referenceFrame, xFields => $xFields);
};
if ($@) {
    warn "Exception when calling ROS2Api->getTransform: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ROS2Api()
frame = frame_example # String | The name of the frame to look up
referenceFrame = referenceFrame_example # String | The reference frame (optional) (default to world)
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Lookup a transform from the TF buffer
    api_instance.get_transform(frame, referenceFrame=referenceFrame, xFields=xFields)
except ApiException as e:
    print("Exception when calling ROS2Api->getTransform: %s\n" % e)

Parameters

Path parameters
Name Description
frame*
String
The name of the frame to look up
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Query parameters
Name Description
reference_frame
String
The reference frame

Responses

Status: 200 - Transform found

Status: 404 - Transform not found

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


loadPackageFile

Load a file from a ROS package


/v2/ros/load-package-file

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/ros/load-package-file?package=&file="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ROS2Api;

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

public class ROS2ApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ROS2Api apiInstance = new ROS2Api();
        String package = package_example; // String | The package name
        String file = file_example; // String | The file name
        try {
            apiInstance.loadPackageFile(package, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#loadPackageFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ROS2Api;

public class ROS2ApiExample {

    public static void main(String[] args) {
        ROS2Api apiInstance = new ROS2Api();
        String package = package_example; // String | The package name
        String file = file_example; // String | The file name
        try {
            apiInstance.loadPackageFile(package, file);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#loadPackageFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *package = package_example; // The package name
String *file = file_example; // The file name

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

// Load a file from a ROS package
[apiInstance loadPackageFileWith:package
    file:file
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ROS2Api()

var package = package_example; // {String} The package name

var file = file_example; // {String} The file name


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

namespace Example
{
    public class loadPackageFileExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ROS2Api();
            var package = package_example;  // String | The package name
            var file = file_example;  // String | The file name

            try
            {
                // Load a file from a ROS package
                apiInstance.loadPackageFile(package, file);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ROS2Api.loadPackageFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ROS2Api();
$package = package_example; // String | The package name
$file = file_example; // String | The file name

try {
    $api_instance->loadPackageFile($package, $file);
} catch (Exception $e) {
    echo 'Exception when calling ROS2Api->loadPackageFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ROS2Api;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ROS2Api->new();
my $package = package_example; # String | The package name
my $file = file_example; # String | The file name

eval { 
    $api_instance->loadPackageFile(package => $package, file => $file);
};
if ($@) {
    warn "Exception when calling ROS2Api->loadPackageFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ROS2Api()
package = package_example # String | The package name
file = file_example # String | The file name

try: 
    # Load a file from a ROS package
    api_instance.load_package_file(package, file)
except ApiException as e:
    print("Exception when calling ROS2Api->loadPackageFile: %s\n" % e)

Parameters

Query parameters
Name Description
package*
String
The package name
Required
file*
String
The file name
Required

Responses

Status: 404 - File not found

Status: 200 - File found and content returned

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


sendRTCOffer

Start the Offer/Answer exchange for WebRTC


/v2/ros/rtc-offer

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/ros/rtc-offer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ROS2Api;

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

public class ROS2ApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        ROS2Api apiInstance = new ROS2Api();
        Payload_7 payload = ; // Payload_7 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            WebRTC%20Answer result = apiInstance.sendRTCOffer(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#sendRTCOffer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ROS2Api;

public class ROS2ApiExample {

    public static void main(String[] args) {
        ROS2Api apiInstance = new ROS2Api();
        Payload_7 payload = ; // Payload_7 | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            WebRTC%20Answer result = apiInstance.sendRTCOffer(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ROS2Api#sendRTCOffer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

Payload_7 *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Start the Offer/Answer exchange for WebRTC
[apiInstance sendRTCOfferWith:payload
    xFields:xFields
              completionHandler: ^(WebRTC%20Answer output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.ROS2Api()

var payload = ; // {Payload_7} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class sendRTCOfferExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ROS2Api();
            var payload = new Payload_7(); // Payload_7 | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Start the Offer/Answer exchange for WebRTC
                WebRTC%20Answer result = apiInstance.sendRTCOffer(payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ROS2Api.sendRTCOffer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\ROS2Api();
$payload = ; // Payload_7 | 
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ROS2Api->new();
my $payload = WWW::SwaggerClient::Object::Payload_7->new(); # Payload_7 | 
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ROS2Api()
payload =  # Payload_7 | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Start the Offer/Answer exchange for WebRTC
    api_response = api_instance.send_rtc_offer(payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ROS2Api->sendRTCOffer: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


Root

getComponentDescriptions

Get a collection of component descriptions

Retrieve a dictionary of all registered component descriptions on the system image.


/v2/components

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/components"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootApi;

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

public class RootApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Component%20Descriptions result = apiInstance.getComponentDescriptions(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getComponentDescriptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootApi;

public class RootApiExample {

    public static void main(String[] args) {
        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Component%20Descriptions result = apiInstance.getComponentDescriptions(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getComponentDescriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get a collection of component descriptions
[apiInstance getComponentDescriptionsWith:xFields
              completionHandler: ^(Component%20Descriptions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.RootApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getComponentDescriptionsExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RootApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get a collection of component descriptions
                Component%20Descriptions result = apiInstance.getComponentDescriptions(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootApi.getComponentDescriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\RootApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RootApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RootApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get a collection of component descriptions
    api_response = api_instance.get_component_descriptions(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootApi->getComponentDescriptions: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getControllerDescriptions

Get a collection of controller descriptions

Retrieve a dictionary of all registered controller descriptions on the system image.


/v2/controllers

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/controllers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootApi;

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

public class RootApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Controller%20Descriptions result = apiInstance.getControllerDescriptions(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getControllerDescriptions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootApi;

public class RootApiExample {

    public static void main(String[] args) {
        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Controller%20Descriptions result = apiInstance.getControllerDescriptions(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getControllerDescriptions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get a collection of controller descriptions
[apiInstance getControllerDescriptionsWith:xFields
              completionHandler: ^(Controller%20Descriptions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.RootApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getControllerDescriptionsExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RootApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get a collection of controller descriptions
                Controller%20Descriptions result = apiInstance.getControllerDescriptions(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootApi.getControllerDescriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\RootApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RootApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RootApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get a collection of controller descriptions
    api_response = api_instance.get_controller_descriptions(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootApi->getControllerDescriptions: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: monitor

Status: 401 - Missing or invalid authentication


getFeatures

Get the available features


/v2/features

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/features"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootApi;

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

public class RootApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Features result = apiInstance.getFeatures(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getFeatures");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootApi;

public class RootApiExample {

    public static void main(String[] args) {
        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            Features result = apiInstance.getFeatures(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getFeatures");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get the available features
[apiInstance getFeaturesWith:xFields
              completionHandler: ^(Features output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.RootApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getFeaturesExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RootApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get the available features
                Features result = apiInstance.getFeatures(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootApi.getFeatures: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\RootApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RootApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RootApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get the available features
    api_response = api_instance.get_features(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RootApi->getFeatures: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: status

Status: 401 - Missing or invalid authentication


getLicensingStatus

Get the current licensing status

Retrieve a dictionary of all signed packages and their versions and a list of license entitlements.


/v2/license

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/license"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RootApi;

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

public class RootApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            apiInstance.getLicensingStatus(xFields);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getLicensingStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RootApi;

public class RootApiExample {

    public static void main(String[] args) {
        RootApi apiInstance = new RootApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            apiInstance.getLicensingStatus(xFields);
        } catch (ApiException e) {
            System.err.println("Exception when calling RootApi#getLicensingStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get the current licensing status
[apiInstance getLicensingStatusWith:xFields
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.RootApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getLicensingStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new RootApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get the current licensing status
                apiInstance.getLicensingStatus(xFields);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RootApi.getLicensingStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\RootApi();
$xFields = xFields_example; // String | An optional fields mask

try {
    $api_instance->getLicensingStatus($xFields);
} catch (Exception $e) {
    echo 'Exception when calling RootApi->getLicensingStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RootApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::RootApi->new();
my $xFields = xFields_example; # String | An optional fields mask

eval { 
    $api_instance->getLicensingStatus(xFields => $xFields);
};
if ($@) {
    warn "Exception when calling RootApi->getLicensingStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.RootApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get the current licensing status
    api_instance.get_licensing_status(xFields=xFields)
except ApiException as e:
    print("Exception when calling RootApi->getLicensingStatus: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Licensing status

Status: 404 - Licensing status not found

Status: 403 - Missing one of the required scopes: user

Status: 401 - Missing or invalid authentication


Users

changePassword

Change user password


/v2/users/me/password

Usage and SDK Samples

curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Basic [[basicHash]]" "https://localhost/api/v2/users/me/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: userPassword
        HttpBasicAuth userPassword = (HttpBasicAuth) defaultClient.getAuthentication("userPassword");
        userPassword.setUsername("YOUR USERNAME");
        userPassword.setPassword("YOUR PASSWORD");

        UsersApi apiInstance = new UsersApi();
        UserPassword payload = ; // UserPassword | 
        try {
            apiInstance.changePassword(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changePassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserPassword payload = ; // UserPassword | 
        try {
            apiInstance.changePassword(payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#changePassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure HTTP basic authorization (authentication scheme: userPassword)
[apiConfig setUsername:@"YOUR_USERNAME"];
[apiConfig setPassword:@"YOUR_PASSWORD"];

UserPassword *payload = ; // 

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

// Change user password
[apiInstance changePasswordWith:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure HTTP basic authorization: userPassword
var userPassword = defaultClient.authentications['userPassword'];
userPassword.username = 'YOUR USERNAME'
userPassword.password = 'YOUR PASSWORD'

var api = new AicaApi.UsersApi()

var payload = ; // {UserPassword} 


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

namespace Example
{
    public class changePasswordExample
    {
        public void main()
        {
            
            // Configure HTTP basic authorization: userPassword
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new UsersApi();
            var payload = new UserPassword(); // UserPassword | 

            try
            {
                // Change user password
                apiInstance.changePassword(payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.changePassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: userPassword
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\UsersApi();
$payload = ; // UserPassword | 

try {
    $api_instance->changePassword($payload);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->changePassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure HTTP basic authorization: userPassword
$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $payload = WWW::SwaggerClient::Object::UserPassword->new(); # UserPassword | 

eval { 
    $api_instance->changePassword(payload => $payload);
};
if ($@) {
    warn "Exception when calling UsersApi->changePassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: userPassword
swagger_client.configuration.username = 'YOUR_USERNAME'
swagger_client.configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
payload =  # UserPassword | 

try: 
    # Change user password
    api_instance.change_password(payload)
except ApiException as e:
    print("Exception when calling UsersApi->changePassword: %s\n" % e)

Parameters

Body parameters
Name Description
payload *

Responses

Status: 400 - Invalid password

Status: 204 - Password changed

Status: 401 - Missing or invalid authentication


createAPIKey

Create new token


/v2/users/me/api-keys

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/me/api-keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        APIKeyPayload payload = ; // APIKeyPayload | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            NewAPIKey result = apiInstance.createAPIKey(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createAPIKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        APIKeyPayload payload = ; // APIKeyPayload | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            NewAPIKey result = apiInstance.createAPIKey(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createAPIKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

APIKeyPayload *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Create new token
[apiInstance createAPIKeyWith:payload
    xFields:xFields
              completionHandler: ^(NewAPIKey output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var payload = ; // {APIKeyPayload} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class createAPIKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var payload = new APIKeyPayload(); // APIKeyPayload | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Create new token
                NewAPIKey result = apiInstance.createAPIKey(payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createAPIKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$payload = ; // APIKeyPayload | 
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $payload = WWW::SwaggerClient::Object::APIKeyPayload->new(); # APIKeyPayload | 
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
payload =  # APIKeyPayload | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Create new token
    api_response = api_instance.create_api_key(payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createAPIKey: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 400 - Invalid token details

Status: 201 - Success

Status: 403 - Missing one of the required scopes: user

Status: 401 - Missing or invalid authentication


createUser

Create new user


/v2/users

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        UserPayload payload = ; // UserPayload | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            NewUser result = apiInstance.createUser(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserPayload payload = ; // UserPayload | 
        String xFields = xFields_example; // String | An optional fields mask
        try {
            NewUser result = apiInstance.createUser(payload, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

UserPayload *payload = ; // 
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Create new user
[apiInstance createUserWith:payload
    xFields:xFields
              completionHandler: ^(NewUser output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var payload = ; // {UserPayload} 

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var payload = new UserPayload(); // UserPayload | 
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Create new user
                NewUser result = apiInstance.createUser(payload, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$payload = ; // UserPayload | 
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $payload = WWW::SwaggerClient::Object::UserPayload->new(); # UserPayload | 
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
payload =  # UserPayload | 
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Create new user
    api_response = api_instance.create_user(payload, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createUser: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask
Body parameters
Name Description
payload *

Responses

Status: 400 - Invalid user details

Status: 201 - Success

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


deleteAPIKey

Delete token


/v2/users/me/api-keys/{token_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/me/api-keys/{token_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String tokenId = tokenId_example; // String | The token to effect
        try {
            apiInstance.deleteAPIKey(tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteAPIKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String tokenId = tokenId_example; // String | The token to effect
        try {
            apiInstance.deleteAPIKey(tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteAPIKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *tokenId = tokenId_example; // The token to effect

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

// Delete token
[apiInstance deleteAPIKeyWith:tokenId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var tokenId = tokenId_example; // {String} The token to effect


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

namespace Example
{
    public class deleteAPIKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var tokenId = tokenId_example;  // String | The token to effect

            try
            {
                // Delete token
                apiInstance.deleteAPIKey(tokenId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteAPIKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$tokenId = tokenId_example; // String | The token to effect

try {
    $api_instance->deleteAPIKey($tokenId);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->deleteAPIKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $tokenId = tokenId_example; # String | The token to effect

eval { 
    $api_instance->deleteAPIKey(tokenId => $tokenId);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteAPIKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
tokenId = tokenId_example # String | The token to effect

try: 
    # Delete token
    api_instance.delete_api_key(tokenId)
except ApiException as e:
    print("Exception when calling UsersApi->deleteAPIKey: %s\n" % e)

Parameters

Path parameters
Name Description
token_id*
String
The token to effect
Required

Responses

Status: 404 - Token not found

Status: 204 - Token deleted

Status: 403 - Missing one of the required scopes: user

Status: 401 - Missing or invalid authentication


deleteUser

Delete user


/v2/users/{user_id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *userId = userId_example; // The user to effect

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

// Delete user
[apiInstance deleteUserWith:userId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var userId = userId_example; // {String} The user to effect


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

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | The user to effect

            try
            {
                // Delete user
                apiInstance.deleteUser(userId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | The user to effect

try {
    $api_instance->deleteUser($userId);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | The user to effect

eval { 
    $api_instance->deleteUser(userId => $userId);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | The user to effect

try: 
    # Delete user
    api_instance.delete_user(userId)
except ApiException as e:
    print("Exception when calling UsersApi->deleteUser: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
String
The user to effect
Required

Responses

Status: 404 - User not found

Status: 204 - User deleted

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


getMe

Get current user


/v2/users/me

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/me"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            User result = apiInstance.getMe(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getMe");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            User result = apiInstance.getMe(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getMe");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get current user
[apiInstance getMeWith:xFields
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getMeExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get current user
                User result = apiInstance.getMe(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getMe: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get current user
    api_response = api_instance.get_me(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getMe: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes:

Status: 401 - Missing or invalid authentication


getMyAPIKeys

Get current user tokens


/v2/users/me/api-keys

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/me/api-keys"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            APIKeyList result = apiInstance.getMyAPIKeys(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getMyAPIKeys");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            APIKeyList result = apiInstance.getMyAPIKeys(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getMyAPIKeys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get current user tokens
[apiInstance getMyAPIKeysWith:xFields
              completionHandler: ^(APIKeyList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getMyAPIKeysExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get current user tokens
                APIKeyList result = apiInstance.getMyAPIKeys(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getMyAPIKeys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get current user tokens
    api_response = api_instance.get_my_api_keys(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getMyAPIKeys: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: user

Status: 401 - Missing or invalid authentication


getUser

Get user by ID


/v2/users/{user_id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        String xFields = xFields_example; // String | An optional fields mask
        try {
            User result = apiInstance.getUser(userId, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        String xFields = xFields_example; // String | An optional fields mask
        try {
            User result = apiInstance.getUser(userId, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *userId = userId_example; // The user to effect
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Get user by ID
[apiInstance getUserWith:userId
    xFields:xFields
              completionHandler: ^(User output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var userId = userId_example; // {String} The user to effect

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | The user to effect
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Get user by ID
                User result = apiInstance.getUser(userId, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | The user to effect
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | The user to effect
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | The user to effect
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Get user by ID
    api_response = api_instance.get_user(userId, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUser: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
String
The user to effect
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 404 - User not found

Status: 200 - Success

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


getUsers

List available users


/v2/users

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            UserList result = apiInstance.getUsers(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String xFields = xFields_example; // String | An optional fields mask
        try {
            UserList result = apiInstance.getUsers(xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *xFields = xFields_example; // An optional fields mask (optional)

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

// List available users
[apiInstance getUsersWith:xFields
              completionHandler: ^(UserList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // List available users
                UserList result = apiInstance.getUsers(xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # List available users
    api_response = api_instance.get_users(xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)

Parameters

Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 200 - Success

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


resetUserPassword

Reset user password


/v2/users/{user_id}/password

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/{user_id}/password"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        String xFields = xFields_example; // String | An optional fields mask
        try {
            UserPassword result = apiInstance.resetUserPassword(userId, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#resetUserPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        String xFields = xFields_example; // String | An optional fields mask
        try {
            UserPassword result = apiInstance.resetUserPassword(userId, xFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#resetUserPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *userId = userId_example; // The user to effect
String *xFields = xFields_example; // An optional fields mask (optional)

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

// Reset user password
[apiInstance resetUserPasswordWith:userId
    xFields:xFields
              completionHandler: ^(UserPassword output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var userId = userId_example; // {String} The user to effect

var opts = { 
  'xFields': xFields_example // {String} An optional fields mask
};

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

namespace Example
{
    public class resetUserPasswordExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | The user to effect
            var xFields = xFields_example;  // String | An optional fields mask (optional) 

            try
            {
                // Reset user password
                UserPassword result = apiInstance.resetUserPassword(userId, xFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.resetUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | The user to effect
$xFields = xFields_example; // String | An optional fields mask

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

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | The user to effect
my $xFields = xFields_example; # String | An optional fields mask

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

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | The user to effect
xFields = xFields_example # String | An optional fields mask (optional)

try: 
    # Reset user password
    api_response = api_instance.reset_user_password(userId, xFields=xFields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->resetUserPassword: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
String
The user to effect
Required
Header parameters
Name Description
X-Fields
String (mask)
An optional fields mask

Responses

Status: 404 - User not found

Status: 200 - Success

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication


updateAPIKey

Update token details


/v2/users/me/api-keys/{token_id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/me/api-keys/{token_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String tokenId = tokenId_example; // String | The token to effect
        APIKeyUpdatePayload payload = ; // APIKeyUpdatePayload | 
        try {
            apiInstance.updateAPIKey(tokenId, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateAPIKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String tokenId = tokenId_example; // String | The token to effect
        APIKeyUpdatePayload payload = ; // APIKeyUpdatePayload | 
        try {
            apiInstance.updateAPIKey(tokenId, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateAPIKey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *tokenId = tokenId_example; // The token to effect
APIKeyUpdatePayload *payload = ; // 

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

// Update token details
[apiInstance updateAPIKeyWith:tokenId
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var tokenId = tokenId_example; // {String} The token to effect

var payload = ; // {APIKeyUpdatePayload} 


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

namespace Example
{
    public class updateAPIKeyExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var tokenId = tokenId_example;  // String | The token to effect
            var payload = new APIKeyUpdatePayload(); // APIKeyUpdatePayload | 

            try
            {
                // Update token details
                apiInstance.updateAPIKey(tokenId, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateAPIKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$tokenId = tokenId_example; // String | The token to effect
$payload = ; // APIKeyUpdatePayload | 

try {
    $api_instance->updateAPIKey($tokenId, $payload);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateAPIKey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $tokenId = tokenId_example; # String | The token to effect
my $payload = WWW::SwaggerClient::Object::APIKeyUpdatePayload->new(); # APIKeyUpdatePayload | 

eval { 
    $api_instance->updateAPIKey(tokenId => $tokenId, payload => $payload);
};
if ($@) {
    warn "Exception when calling UsersApi->updateAPIKey: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
tokenId = tokenId_example # String | The token to effect
payload =  # APIKeyUpdatePayload | 

try: 
    # Update token details
    api_instance.update_api_key(tokenId, payload)
except ApiException as e:
    print("Exception when calling UsersApi->updateAPIKey: %s\n" % e)

Parameters

Path parameters
Name Description
token_id*
String
The token to effect
Required
Body parameters
Name Description
payload *

Responses

Status: 404 - Token not found

Status: 400 - Invalid token details

Status: 204 - Token updated

Status: 403 - Missing one of the required scopes: user

Status: 401 - Missing or invalid authentication


updateUser

Update user details


/v2/users/{user_id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/api/v2/users/{user_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: token
        ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
        token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //token.setApiKeyPrefix("Token");

        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        UserPayload payload = ; // UserPayload | 
        try {
            apiInstance.updateUser(userId, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String userId = userId_example; // String | The user to effect
        UserPayload payload = ; // UserPayload | 
        try {
            apiInstance.updateUser(userId, payload);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

String *userId = userId_example; // The user to effect
UserPayload *payload = ; // 

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

// Update user details
[apiInstance updateUserWith:userId
    payload:payload
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AicaApi = require('aica_api');
var defaultClient = AicaApi.ApiClient.instance;

// Configure API key authorization: token
var token = defaultClient.authentications['token'];
token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//token.apiKeyPrefix['Authorization'] = "Token"

var api = new AicaApi.UsersApi()

var userId = userId_example; // {String} The user to effect

var payload = ; // {UserPayload} 


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

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new UsersApi();
            var userId = userId_example;  // String | The user to effect
            var payload = new UserPayload(); // UserPayload | 

            try
            {
                // Update user details
                apiInstance.updateUser(userId, payload);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: token
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\Api\UsersApi();
$userId = userId_example; // String | The user to effect
$payload = ; // UserPayload | 

try {
    $api_instance->updateUser($userId, $payload);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

# Configure API key authorization: token
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $userId = userId_example; # String | The user to effect
my $payload = WWW::SwaggerClient::Object::UserPayload->new(); # UserPayload | 

eval { 
    $api_instance->updateUser(userId => $userId, payload => $payload);
};
if ($@) {
    warn "Exception when calling UsersApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: token
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.UsersApi()
userId = userId_example # String | The user to effect
payload =  # UserPayload | 

try: 
    # Update user details
    api_instance.update_user(userId, payload)
except ApiException as e:
    print("Exception when calling UsersApi->updateUser: %s\n" % e)

Parameters

Path parameters
Name Description
user_id*
String
The user to effect
Required
Body parameters
Name Description
payload *

Responses

Status: 404 - User not found

Status: 400 - Invalid changes

Status: 204 - User updated

Status: 403 - Missing one of the required scopes: admin

Status: 401 - Missing or invalid authentication