Linkar REST API 2.3.0

ManagerApi

apiManagerClientSessionDeleteClientSessionIdGet

Deletes an existing Client Session


/api/Manager/ClientSession/Delete/{client_session_id}

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/ClientSession/Delete/{client_session_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String clientSessionId = clientSessionId_example; // String | Identificador de la sesión de cliente
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerClientSessionDeleteClientSessionIdGet(clientSessionId, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerClientSessionDeleteClientSessionIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String clientSessionId = clientSessionId_example; // String | Identificador de la sesión de cliente
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerClientSessionDeleteClientSessionIdGet(clientSessionId, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerClientSessionDeleteClientSessionIdGet");
            e.printStackTrace();
        }
    }
}
String *clientSessionId = clientSessionId_example; // Identificador de la sesión de cliente
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Deletes an existing Client Session
[apiInstance apiManagerClientSessionDeleteClientSessionIdGetWith:clientSessionId
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var clientSessionId = clientSessionId_example; // {{String}} Identificador de la sesión de cliente
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerClientSessionDeleteClientSessionIdGet(clientSessionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var clientSessionId = clientSessionId_example;  // String | Identificador de la sesión de cliente
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Deletes an existing Client Session
                Message result = apiInstance.apiManagerClientSessionDeleteClientSessionIdGet(clientSessionId, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerClientSessionDeleteClientSessionIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$clientSessionId = clientSessionId_example; // String | Identificador de la sesión de cliente
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $clientSessionId = clientSessionId_example; # String | Identificador de la sesión de cliente
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerClientSessionDeleteClientSessionIdGet(clientSessionId => $clientSessionId, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerClientSessionDeleteClientSessionIdGet: $@\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.ManagerApiApi()
clientSessionId = clientSessionId_example # String | Identificador de la sesión de cliente
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Deletes an existing Client Session
    api_response = api_instance.api_manager_client_session_delete_client_session_id_get(clientSessionId, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerClientSessionDeleteClientSessionIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
client_session_id*
String
Identificador de la sesión de cliente
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


apiManagerClientSessionMonitorGet

Gets the status of Client Sessions


/api/Manager/ClientSession/Monitor

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/ClientSession/Monitor"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            array[ClientSessionMonitor] result = apiInstance.apiManagerClientSessionMonitorGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerClientSessionMonitorGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            array[ClientSessionMonitor] result = apiInstance.apiManagerClientSessionMonitorGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerClientSessionMonitorGet");
            e.printStackTrace();
        }
    }
}
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the status of Client Sessions
[apiInstance apiManagerClientSessionMonitorGetWith:aPIKey
              completionHandler: ^(array[ClientSessionMonitor] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerClientSessionMonitorGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the status of Client Sessions
                array[ClientSessionMonitor] result = apiInstance.apiManagerClientSessionMonitorGet(aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerClientSessionMonitorGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerClientSessionMonitorGet(aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerClientSessionMonitorGet: $@\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.ManagerApiApi()
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the status of Client Sessions
    api_response = api_instance.api_manager_client_session_monitor_get(aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerClientSessionMonitorGet: %s\n" % e)

Parameters

Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet

Add On Demmand or Temporal Sessions to an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/AddSessions/{sessions}/OnDemand

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/AddSessions/{sessions}/OnDemand"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Temporal Sessions to be added
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Temporal Sessions to be added
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *sessions = 56; // Number of Temporal Sessions to be added
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Add On Demmand or Temporal Sessions to an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGetWith:profileName
    entrypointName:entrypointName
    sessions:sessions
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var sessions = 56; // {{Integer}} Number of Temporal Sessions to be added
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var sessions = 56;  // Integer | Number of Temporal Sessions to be added
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Add On Demmand or Temporal Sessions to an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$sessions = 56; // Integer | Number of Temporal Sessions to be added
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet($profileName, $entrypointName, $sessions, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $sessions = 56; # Integer | Number of Temporal Sessions to be added
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet(profileName => $profileName, entrypointName => $entrypointName, sessions => $sessions, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
sessions = 56 # Integer | Number of Temporal Sessions to be added
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Add On Demmand or Temporal Sessions to an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_add_sessions_sessions_on_demand_get(profileName, entrypointName, sessions, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsOnDemandGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
sessions*
Integer (int32)
Number of Temporal Sessions to be added
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet

Add Permanent Sessions to an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/AddSessions/{sessions}/Permanent

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/AddSessions/{sessions}/Permanent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Permanent Sessions to be added
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Permanent Sessions to be added
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *sessions = 56; // Number of Permanent Sessions to be added
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Add Permanent Sessions to an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGetWith:profileName
    entrypointName:entrypointName
    sessions:sessions
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var sessions = 56; // {{Integer}} Number of Permanent Sessions to be added
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet(profileName, entrypointName, sessions, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var sessions = 56;  // Integer | Number of Permanent Sessions to be added
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Add Permanent Sessions to an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$sessions = 56; // Integer | Number of Permanent Sessions to be added
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet($profileName, $entrypointName, $sessions, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $sessions = 56; # Integer | Number of Permanent Sessions to be added
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet(profileName => $profileName, entrypointName => $entrypointName, sessions => $sessions, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
sessions = 56 # Integer | Number of Permanent Sessions to be added
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Add Permanent Sessions to an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_add_sessions_sessions_permanent_get(profileName, entrypointName, sessions, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameAddSessionsSessionsPermanentGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
sessions*
Integer (int32)
Number of Permanent Sessions to be added
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet

Gets the health of an EntryPoint, UP or DOWN


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Health

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Health"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the health of an EntryPoint, UP or DOWN
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameHealthGetWith:profileName
    entrypointName:entrypointName
    aPIKey:aPIKey
              completionHandler: ^(Health output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet(profileName, entrypointName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the health of an EntryPoint, UP or DOWN
                Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet(profileName, entrypointName, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet($profileName, $entrypointName, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet(profileName => $profileName, entrypointName => $entrypointName, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the health of an EntryPoint, UP or DOWN
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_health_get(profileName, entrypointName, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameHealthGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet

Gets the status of an EntryPoint and all its sessions


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Monitor

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Monitor"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            EntryPointMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            EntryPointMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the status of an EntryPoint and all its sessions
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGetWith:profileName
    entrypointName:entrypointName
    aPIKey:aPIKey
              completionHandler: ^(EntryPointMonitor output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet(profileName, entrypointName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the status of an EntryPoint and all its sessions
                EntryPointMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet(profileName, entrypointName, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet($profileName, $entrypointName, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet(profileName => $profileName, entrypointName => $entrypointName, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the status of an EntryPoint and all its sessions
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_monitor_get(profileName, entrypointName, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameMonitorGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet

Remove On Demand or Temporal Sessions from an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/RemoveSessions/{sessions}/OnDemand

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/RemoveSessions/{sessions}/OnDemand"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Temporal Sessions to be removed
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Temporal Sessions to be removed
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *sessions = 56; // Number of Temporal Sessions to be removed
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Remove On Demand or Temporal Sessions from an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGetWith:profileName
    entrypointName:entrypointName
    sessions:sessions
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var sessions = 56; // {{Integer}} Number of Temporal Sessions to be removed
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var sessions = 56;  // Integer | Number of Temporal Sessions to be removed
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Remove On Demand or Temporal Sessions from an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet(profileName, entrypointName, sessions, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$sessions = 56; // Integer | Number of Temporal Sessions to be removed
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet($profileName, $entrypointName, $sessions, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $sessions = 56; # Integer | Number of Temporal Sessions to be removed
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet(profileName => $profileName, entrypointName => $entrypointName, sessions => $sessions, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
sessions = 56 # Integer | Number of Temporal Sessions to be removed
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Remove On Demand or Temporal Sessions from an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_remove_sessions_sessions_on_demand_get(profileName, entrypointName, sessions, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsOnDemandGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
sessions*
Integer (int32)
Number of Temporal Sessions to be removed
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet

Remove Permanent Sessions from an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/RemoveSessions/{sessions}/Permanent

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/RemoveSessions/{sessions}/Permanent"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Permanent Sessions to be removed
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer sessions = 56; // Integer | Number of Permanent Sessions to be removed
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *sessions = 56; // Number of Permanent Sessions to be removed
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Remove Permanent Sessions from an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGetWith:profileName
    entrypointName:entrypointName
    sessions:sessions
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var sessions = 56; // {{Integer}} Number of Permanent Sessions to be removed
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet(profileName, entrypointName, sessions, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var sessions = 56;  // Integer | Number of Permanent Sessions to be removed
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Remove Permanent Sessions from an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet(profileName, entrypointName, sessions, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$sessions = 56; // Integer | Number of Permanent Sessions to be removed
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet($profileName, $entrypointName, $sessions, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $sessions = 56; # Integer | Number of Permanent Sessions to be removed
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet(profileName => $profileName, entrypointName => $entrypointName, sessions => $sessions, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
sessions = 56 # Integer | Number of Permanent Sessions to be removed
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Remove Permanent Sessions from an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_remove_sessions_sessions_permanent_get(profileName, entrypointName, sessions, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameRemoveSessionsSessionsPermanentGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
sessions*
Integer (int32)
Number of Permanent Sessions to be removed
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet

Resets the COMMON variables with the 100 most used files


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/ResetCommonBlock

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/ResetCommonBlock"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Resets the COMMON variables with the 100 most used files
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGetWith:profileName
    entrypointName:entrypointName
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet(profileName, entrypointName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Resets the COMMON variables with the 100 most used files
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet(profileName, entrypointName, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet($profileName, $entrypointName, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet(profileName => $profileName, entrypointName => $entrypointName, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Resets the COMMON variables with the 100 most used files
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_reset_common_block_get(profileName, entrypointName, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameResetCommonBlockGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet

Close a Database Session


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Close

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Close"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *linkarLine = 56; // Linkar line number
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Close a Database Session
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGetWith:profileName
    entrypointName:entrypointName
    linkarLine:linkarLine
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var linkarLine = 56; // {{Integer}} Linkar line number
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet(profileName, entrypointName, linkarLine, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var linkarLine = 56;  // Integer | Linkar line number
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Close a Database Session
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet(profileName, entrypointName, linkarLine, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$linkarLine = 56; // Integer | Linkar line number
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet($profileName, $entrypointName, $linkarLine, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $linkarLine = 56; # Integer | Linkar line number
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet(profileName => $profileName, entrypointName => $entrypointName, linkarLine => $linkarLine, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
linkarLine = 56 # Integer | Linkar line number
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Close a Database Session
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_session_linkar_line_close_get(profileName, entrypointName, linkarLine, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineCloseGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
linkar_line*
Integer (int32)
Linkar line number
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet

Gets the health of a Database Session, UP or DOWN


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Health

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Health"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *linkarLine = 56; // Linkar line number
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the health of a Database Session, UP or DOWN
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGetWith:profileName
    entrypointName:entrypointName
    linkarLine:linkarLine
    aPIKey:aPIKey
              completionHandler: ^(Health output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var linkarLine = 56; // {{Integer}} Linkar line number
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet(profileName, entrypointName, linkarLine, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var linkarLine = 56;  // Integer | Linkar line number
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the health of a Database Session, UP or DOWN
                Health result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet(profileName, entrypointName, linkarLine, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$linkarLine = 56; // Integer | Linkar line number
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet($profileName, $entrypointName, $linkarLine, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $linkarLine = 56; # Integer | Linkar line number
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet(profileName => $profileName, entrypointName => $entrypointName, linkarLine => $linkarLine, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
linkarLine = 56 # Integer | Linkar line number
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the health of a Database Session, UP or DOWN
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_session_linkar_line_health_get(profileName, entrypointName, linkarLine, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineHealthGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
linkar_line*
Integer (int32)
Linkar line number
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet

Kill a Database Session


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Kill

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Kill"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *linkarLine = 56; // Linkar line number
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Kill a Database Session
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGetWith:profileName
    entrypointName:entrypointName
    linkarLine:linkarLine
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var linkarLine = 56; // {{Integer}} Linkar line number
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet(profileName, entrypointName, linkarLine, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var linkarLine = 56;  // Integer | Linkar line number
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Kill a Database Session
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet(profileName, entrypointName, linkarLine, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$linkarLine = 56; // Integer | Linkar line number
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet($profileName, $entrypointName, $linkarLine, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $linkarLine = 56; # Integer | Linkar line number
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet(profileName => $profileName, entrypointName => $entrypointName, linkarLine => $linkarLine, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
linkarLine = 56 # Integer | Linkar line number
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Kill a Database Session
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_session_linkar_line_kill_get(profileName, entrypointName, linkarLine, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineKillGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
linkar_line*
Integer (int32)
Linkar line number
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet

Gets the status of a Database Session.


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Monitor

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Monitor"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            SessionMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            SessionMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *linkarLine = 56; // Linkar line number
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the status of a Database Session.
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGetWith:profileName
    entrypointName:entrypointName
    linkarLine:linkarLine
    aPIKey:aPIKey
              completionHandler: ^(SessionMonitor output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var linkarLine = 56; // {{Integer}} Linkar line number
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet(profileName, entrypointName, linkarLine, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var linkarLine = 56;  // Integer | Linkar line number
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the status of a Database Session.
                SessionMonitor result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet(profileName, entrypointName, linkarLine, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$linkarLine = 56; // Integer | Linkar line number
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet($profileName, $entrypointName, $linkarLine, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $linkarLine = 56; # Integer | Linkar line number
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet(profileName => $profileName, entrypointName => $entrypointName, linkarLine => $linkarLine, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
linkarLine = 56 # Integer | Linkar line number
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the status of a Database Session.
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_session_linkar_line_monitor_get(profileName, entrypointName, linkarLine, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineMonitorGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
linkar_line*
Integer (int32)
Linkar line number
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet

Open a Database Session


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Open

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Session/{linkar_line}/Open"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        Integer linkarLine = 56; // Integer | Linkar line number
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet(profileName, entrypointName, linkarLine, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
Integer *linkarLine = 56; // Linkar line number
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Open a Database Session
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGetWith:profileName
    entrypointName:entrypointName
    linkarLine:linkarLine
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var linkarLine = 56; // {{Integer}} Linkar line number
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet(profileName, entrypointName, linkarLine, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var linkarLine = 56;  // Integer | Linkar line number
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Open a Database Session
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet(profileName, entrypointName, linkarLine, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$linkarLine = 56; // Integer | Linkar line number
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet($profileName, $entrypointName, $linkarLine, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $linkarLine = 56; # Integer | Linkar line number
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet(profileName => $profileName, entrypointName => $entrypointName, linkarLine => $linkarLine, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
linkarLine = 56 # Integer | Linkar line number
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Open a Database Session
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_session_linkar_line_open_get(profileName, entrypointName, linkarLine, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameSessionLinkarLineOpenGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
linkar_line*
Integer (int32)
Linkar line number
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameStartGet

Start an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Start

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStartGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameStartGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStartGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameStartGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Start an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameStartGetWith:profileName
    entrypointName:entrypointName
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameStartGet(profileName, entrypointName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Start an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStartGet(profileName, entrypointName, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameStartGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameStartGet($profileName, $entrypointName, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStartGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameStartGet(profileName => $profileName, entrypointName => $entrypointName, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStartGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Start an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_start_get(profileName, entrypointName, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStartGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerProfileProfileNameEntryPointEntrypointNameStopGet

Stop an EntryPoint


/api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Stop

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Profile/{profile_name}/EntryPoint/{entrypoint_name}/Stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStopGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameStopGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String profileName = profileName_example; // String | Profile name where the EntryPoint is defined
        String entrypointName = entrypointName_example; // String | EntryPoint name
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStopGet(profileName, entrypointName, aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerProfileProfileNameEntryPointEntrypointNameStopGet");
            e.printStackTrace();
        }
    }
}
String *profileName = profileName_example; // Profile name where the EntryPoint is defined
String *entrypointName = entrypointName_example; // EntryPoint name
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Stop an EntryPoint
[apiInstance apiManagerProfileProfileNameEntryPointEntrypointNameStopGetWith:profileName
    entrypointName:entrypointName
    aPIKey:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var profileName = profileName_example; // {{String}} Profile name where the EntryPoint is defined
var entrypointName = entrypointName_example; // {{String}} EntryPoint name
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerProfileProfileNameEntryPointEntrypointNameStopGet(profileName, entrypointName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var profileName = profileName_example;  // String | Profile name where the EntryPoint is defined
            var entrypointName = entrypointName_example;  // String | EntryPoint name
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Stop an EntryPoint
                Message result = apiInstance.apiManagerProfileProfileNameEntryPointEntrypointNameStopGet(profileName, entrypointName, aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerProfileProfileNameEntryPointEntrypointNameStopGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$profileName = profileName_example; // String | Profile name where the EntryPoint is defined
$entrypointName = entrypointName_example; // String | EntryPoint name
$aPIKey = aPIKey_example; // String | Manager API Key

try {
    $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameStopGet($profileName, $entrypointName, $aPIKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStopGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ManagerApiApi;

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $profileName = profileName_example; # String | Profile name where the EntryPoint is defined
my $entrypointName = entrypointName_example; # String | EntryPoint name
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerProfileProfileNameEntryPointEntrypointNameStopGet(profileName => $profileName, entrypointName => $entrypointName, aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStopGet: $@\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.ManagerApiApi()
profileName = profileName_example # String | Profile name where the EntryPoint is defined
entrypointName = entrypointName_example # String | EntryPoint name
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Stop an EntryPoint
    api_response = api_instance.api_manager_profile_profile_name_entry_point_entrypoint_name_stop_get(profileName, entrypointName, aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerProfileProfileNameEntryPointEntrypointNameStopGet: %s\n" % e)

Parameters

Path parameters
Name Description
profile_name*
String
Profile name where the EntryPoint is defined
Required
entrypoint_name*
String
EntryPoint name
Required
Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Server Error


apiManagerServerHealthGet

Gets the health of Linkar Server, UP or DOWN. Also available /health


/api/Manager/Server/Health

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Server/Health"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerServerHealthGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerHealthGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Health result = apiInstance.apiManagerServerHealthGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerHealthGet");
            e.printStackTrace();
        }
    }
}
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the health of Linkar Server, UP or DOWN. Also available /health
[apiInstance apiManagerServerHealthGetWith:aPIKey
              completionHandler: ^(Health output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerServerHealthGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the health of Linkar Server, UP or DOWN. Also available /health
                Health result = apiInstance.apiManagerServerHealthGet(aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerServerHealthGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerServerHealthGet(aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerServerHealthGet: $@\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.ManagerApiApi()
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the health of Linkar Server, UP or DOWN. Also available /health
    api_response = api_instance.api_manager_server_health_get(aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerServerHealthGet: %s\n" % e)

Parameters

Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


apiManagerServerMonitorGet

Gets the status of Linkar Server, all its EntryPoints and its Sessions


/api/Manager/Server/Monitor

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Server/Monitor"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            ServerMonitor result = apiInstance.apiManagerServerMonitorGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerMonitorGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            ServerMonitor result = apiInstance.apiManagerServerMonitorGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerMonitorGet");
            e.printStackTrace();
        }
    }
}
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Gets the status of Linkar Server, all its EntryPoints and its Sessions
[apiInstance apiManagerServerMonitorGetWith:aPIKey
              completionHandler: ^(ServerMonitor output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerServerMonitorGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Gets the status of Linkar Server, all its EntryPoints and its Sessions
                ServerMonitor result = apiInstance.apiManagerServerMonitorGet(aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerServerMonitorGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerServerMonitorGet(aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerServerMonitorGet: $@\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.ManagerApiApi()
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Gets the status of Linkar Server, all its EntryPoints and its Sessions
    api_response = api_instance.api_manager_server_monitor_get(aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerServerMonitorGet: %s\n" % e)

Parameters

Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


apiManagerServerStartGet

Start Linkar Server service


/api/Manager/Server/Start

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Server/Start"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerServerStartGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerStartGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerServerStartGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerStartGet");
            e.printStackTrace();
        }
    }
}
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Start Linkar Server service
[apiInstance apiManagerServerStartGetWith:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerServerStartGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Start Linkar Server service
                Message result = apiInstance.apiManagerServerStartGet(aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerServerStartGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerServerStartGet(aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerServerStartGet: $@\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.ManagerApiApi()
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Start Linkar Server service
    api_response = api_instance.api_manager_server_start_get(aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerServerStartGet: %s\n" % e)

Parameters

Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


apiManagerServerStopGet

Stop Linkar Server service


/api/Manager/Server/Stop

Usage and SDK Samples

curl -X GET\
-H "Accept: text/plain,application/json,text/json,application/xml,text/xml"\
"//api/Manager/Server/Stop"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ManagerApiApi;

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

public class ManagerApiApiExample {

    public static void main(String[] args) {
        
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerServerStopGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerStopGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ManagerApiApi;

public class ManagerApiApiExample {

    public static void main(String[] args) {
        ManagerApiApi apiInstance = new ManagerApiApi();
        String aPIKey = aPIKey_example; // String | Manager API Key
        try {
            Message result = apiInstance.apiManagerServerStopGet(aPIKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagerApiApi#apiManagerServerStopGet");
            e.printStackTrace();
        }
    }
}
String *aPIKey = aPIKey_example; // Manager API Key (optional)

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

// Stop Linkar Server service
[apiInstance apiManagerServerStopGetWith:aPIKey
              completionHandler: ^(Message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.ManagerApiApi()
var opts = { 
  'aPIKey': aPIKey_example // {{String}} Manager API Key
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiManagerServerStopGet(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new ManagerApiApi();
            var aPIKey = aPIKey_example;  // String | Manager API Key (optional) 

            try
            {
                // Stop Linkar Server service
                Message result = apiInstance.apiManagerServerStopGet(aPIKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ManagerApiApi.apiManagerServerStopGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiManagerApiApi();
$aPIKey = aPIKey_example; // String | Manager API Key

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

my $api_instance = WWW::SwaggerClient::ManagerApiApi->new();
my $aPIKey = aPIKey_example; # String | Manager API Key

eval { 
    my $result = $api_instance->apiManagerServerStopGet(aPIKey => $aPIKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagerApiApi->apiManagerServerStopGet: $@\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.ManagerApiApi()
aPIKey = aPIKey_example # String | Manager API Key (optional)

try: 
    # Stop Linkar Server service
    api_response = api_instance.api_manager_server_stop_get(aPIKey=aPIKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagerApiApi->apiManagerServerStopGet: %s\n" % e)

Parameters

Header parameters
Name Description
APIKey
String
Manager API Key

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 500 - Server Error


SendCommandApi

apiConversionPost

Returns the result of executing ICONV() or OCONV() functions from a expression list in the Database.


/api/Conversion

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Conversion"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKCONVERSIONCOMMAND body = ; // LKCONVERSIONCOMMAND | 
        try {
            apiInstance.apiConversionPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiConversionPost");
            e.printStackTrace();
        }
    }
}
LKCONVERSIONCOMMAND *body = ; //  (optional)

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

// Returns the result of executing ICONV() or OCONV() functions from a expression list in the Database.
[apiInstance apiConversionPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKCONVERSIONCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiConversionPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKCONVERSIONCOMMAND(); // LKCONVERSIONCOMMAND |  (optional) 

            try
            {
                // Returns the result of executing ICONV() or OCONV() functions from a expression list in the Database.
                apiInstance.apiConversionPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiConversionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKCONVERSIONCOMMAND | 

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

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

eval { 
    $api_instance->apiConversionPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiConversionPost: $@\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.SendCommandApiApi()
body =  # LKCONVERSIONCOMMAND |  (optional)

try: 
    # Returns the result of executing ICONV() or OCONV() functions from a expression list in the Database.
    api_instance.api_conversion_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiConversionPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: CODE,EXPRESSIONS,TYPE
CODE:
EXPRESSIONS:
TYPE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiDeleteCustomPost

Deletes one or several records in file. Recover Custom item IDs.


/api/DeleteCustom

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/DeleteCustom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKDELETECUSTOMCOMMAND body = ; // LKDELETECUSTOMCOMMAND | 
        try {
            apiInstance.apiDeleteCustomPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiDeleteCustomPost");
            e.printStackTrace();
        }
    }
}
LKDELETECUSTOMCOMMAND *body = ; //  (optional)

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

// Deletes one or several records in file. Recover Custom item IDs.
[apiInstance apiDeleteCustomPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKDELETECUSTOMCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiDeleteCustomPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKDELETECUSTOMCOMMAND(); // LKDELETECUSTOMCOMMAND |  (optional) 

            try
            {
                // Deletes one or several records in file. Recover Custom item IDs.
                apiInstance.apiDeleteCustomPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiDeleteCustomPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKDELETECUSTOMCOMMAND | 

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

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

eval { 
    $api_instance->apiDeleteCustomPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiDeleteCustomPost: $@\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.SendCommandApiApi()
body =  # LKDELETECUSTOMCOMMAND |  (optional)

try: 
    # Deletes one or several records in file. Recover Custom item IDs.
    api_instance.api_delete_custom_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiDeleteCustomPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID always must be specified. But the ORIGINAL_RECORD not always. When ORIGINAL_RECORD tag is specified and the OPTIMISTIC_LOCK tag is set to true, a copy of the record must be provided before the deletion (ORIGINAL_RECORD tag) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the deletion, reads the record and compares it with the copy in ORIGINAL_RECORD, if they are equal the record is deleted. But if they are not equal, it means that the record has been modified by other user and the record will not be deleted. The record will have to be read, and deleted again.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS,RECOVER_RECORD_ID_TYPE
FILE_NAME:
RECORDS:
OPTIMISTIC_LOCK:
CUSTOM_VARS:
OUTPUT_FORMAT:
RECOVER_RECORD_ID_TYPE:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiDeleteLinkarPost

Deletes one or several records in file. Recover Linkar item IDs.


/api/DeleteLinkar

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/DeleteLinkar"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKDELETELINKARCOMMAND body = ; // LKDELETELINKARCOMMAND | 
        try {
            apiInstance.apiDeleteLinkarPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiDeleteLinkarPost");
            e.printStackTrace();
        }
    }
}
LKDELETELINKARCOMMAND *body = ; //  (optional)

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

// Deletes one or several records in file. Recover Linkar item IDs.
[apiInstance apiDeleteLinkarPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKDELETELINKARCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiDeleteLinkarPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKDELETELINKARCOMMAND(); // LKDELETELINKARCOMMAND |  (optional) 

            try
            {
                // Deletes one or several records in file. Recover Linkar item IDs.
                apiInstance.apiDeleteLinkarPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiDeleteLinkarPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKDELETELINKARCOMMAND | 

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

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

eval { 
    $api_instance->apiDeleteLinkarPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiDeleteLinkarPost: $@\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.SendCommandApiApi()
body =  # LKDELETELINKARCOMMAND |  (optional)

try: 
    # Deletes one or several records in file. Recover Linkar item IDs.
    api_instance.api_delete_linkar_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiDeleteLinkarPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID always must be specified. But the ORIGINAL_RECORD not always. When ORIGINAL_RECORD tag is specified and the OPTIMISTIC_LOCK tag is set to true, a copy of the record must be provided before the deletion (ORIGINAL_RECORD tag) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the deletion, reads the record and compares it with the copy in ORIGINAL_RECORD, if they are equal the record is deleted. But if they are not equal, it means that the record has been modified by other user and the record will not be deleted. The record will have to be read, and deleted again.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS,RECOVER_RECORD_ID_TYPE
FILE_NAME:
RECORDS:
OPTIMISTIC_LOCK:
CUSTOM_VARS:
OUTPUT_FORMAT:
RECOVER_RECORD_ID_TYPE:
RECOVER_RECORD_ID_PREFIX:
RECOVER_RECORD_ID_SEPARATOR:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiDeletePost

Deletes one or several records in file.


/api/Delete

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Delete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKDELETECOMMAND body = ; // LKDELETECOMMAND | 
        try {
            apiInstance.apiDeletePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiDeletePost");
            e.printStackTrace();
        }
    }
}
LKDELETECOMMAND *body = ; //  (optional)

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

// Deletes one or several records in file.
[apiInstance apiDeletePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKDELETECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiDeletePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKDELETECOMMAND(); // LKDELETECOMMAND |  (optional) 

            try
            {
                // Deletes one or several records in file.
                apiInstance.apiDeletePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiDeletePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKDELETECOMMAND | 

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

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

eval { 
    $api_instance->apiDeletePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiDeletePost: $@\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.SendCommandApiApi()
body =  # LKDELETECOMMAND |  (optional)

try: 
    # Deletes one or several records in file.
    api_instance.api_delete_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiDeletePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID always must be specified. But the ORIGINAL_RECORD not always. When ORIGINAL_RECORD tag is specified and the OPTIMISTIC_LOCK tag is set to true, a copy of the record must be provided before the deletion (ORIGINAL_RECORD tag) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the deletion, reads the record and compares it with the copy in ORIGINAL_RECORD, if they are equal the record is deleted. But if they are not equal, it means that the record has been modified by other user and the record will not be deleted. The record will have to be read, and deleted again.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS
FILE_NAME:
RECORDS:
OPTIMISTIC_LOCK:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiDictionariesPost

Returns all the dictionaries of a file.


/api/Dictionaries

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Dictionaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKDICTIONARIESCOMMAND body = ; // LKDICTIONARIESCOMMAND | 
        try {
            apiInstance.apiDictionariesPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiDictionariesPost");
            e.printStackTrace();
        }
    }
}
LKDICTIONARIESCOMMAND *body = ; //  (optional)

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

// Returns all the dictionaries of a file.
[apiInstance apiDictionariesPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKDICTIONARIESCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiDictionariesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKDICTIONARIESCOMMAND(); // LKDICTIONARIESCOMMAND |  (optional) 

            try
            {
                // Returns all the dictionaries of a file.
                apiInstance.apiDictionariesPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiDictionariesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKDICTIONARIESCOMMAND | 

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

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

eval { 
    $api_instance->apiDictionariesPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiDictionariesPost: $@\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.SendCommandApiApi()
body =  # LKDICTIONARIESCOMMAND |  (optional)

try: 
    # Returns all the dictionaries of a file.
    api_instance.api_dictionaries_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiDictionariesPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiExecutePost

Allows the execution of any command from the Database.


/api/Execute

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Execute"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKEXECUTECOMMAND body = ; // LKEXECUTECOMMAND | 
        try {
            apiInstance.apiExecutePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiExecutePost");
            e.printStackTrace();
        }
    }
}
LKEXECUTECOMMAND *body = ; //  (optional)

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

// Allows the execution of any command from the Database.
[apiInstance apiExecutePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKEXECUTECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiExecutePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKEXECUTECOMMAND(); // LKEXECUTECOMMAND |  (optional) 

            try
            {
                // Allows the execution of any command from the Database.
                apiInstance.apiExecutePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiExecutePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKEXECUTECOMMAND | 

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

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

eval { 
    $api_instance->apiExecutePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiExecutePost: $@\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.SendCommandApiApi()
body =  # LKEXECUTECOMMAND |  (optional)

try: 
    # Allows the execution of any command from the Database.
    api_instance.api_execute_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiExecutePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: STATEMENT
STATEMENT:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiFormatPost

Returns the result of executing the FMT function in a expressions list in the Database.


/api/Format

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Format"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKFORMATCOMMAND body = ; // LKFORMATCOMMAND | 
        try {
            apiInstance.apiFormatPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiFormatPost");
            e.printStackTrace();
        }
    }
}
LKFORMATCOMMAND *body = ; //  (optional)

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

// Returns the result of executing the FMT function in a expressions list in the Database.
[apiInstance apiFormatPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKFORMATCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiFormatPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKFORMATCOMMAND(); // LKFORMATCOMMAND |  (optional) 

            try
            {
                // Returns the result of executing the FMT function in a expressions list in the Database.
                apiInstance.apiFormatPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiFormatPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKFORMATCOMMAND | 

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

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

eval { 
    $api_instance->apiFormatPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiFormatPost: $@\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.SendCommandApiApi()
body =  # LKFORMATCOMMAND |  (optional)

try: 
    # Returns the result of executing the FMT function in a expressions list in the Database.
    api_instance.api_format_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiFormatPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: EXPRESSIONS,FORMAT_SPEC
FORMAT_SPEC:
EXPRESSIONS:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiGetTableDictionariesPost

Returns a query result in a table format in Dictionaries mode.


/api/GetTableDictionaries

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/GetTableDictionaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKGETTABLEDICTIONARIESCOMMAND body = ; // LKGETTABLEDICTIONARIESCOMMAND | 
        try {
            apiInstance.apiGetTableDictionariesPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiGetTableDictionariesPost");
            e.printStackTrace();
        }
    }
}
LKGETTABLEDICTIONARIESCOMMAND *body = ; //  (optional)

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

// Returns a query result in a table format in Dictionaries mode.
[apiInstance apiGetTableDictionariesPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKGETTABLEDICTIONARIESCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiGetTableDictionariesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKGETTABLEDICTIONARIESCOMMAND(); // LKGETTABLEDICTIONARIESCOMMAND |  (optional) 

            try
            {
                // Returns a query result in a table format in Dictionaries mode.
                apiInstance.apiGetTableDictionariesPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiGetTableDictionariesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKGETTABLEDICTIONARIESCOMMAND | 

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

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

eval { 
    $api_instance->apiGetTableDictionariesPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiGetTableDictionariesPost: $@\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.SendCommandApiApi()
body =  # LKGETTABLEDICTIONARIESCOMMAND |  (optional)

try: 
    # Returns a query result in a table format in Dictionaries mode.
    api_instance.api_get_table_dictionaries_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiGetTableDictionariesPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
SELECT_CLAUSE:
SORT_CLAUSE:
DICT_CLAUSE:
ROWHEADERS:
REPEATVALUES:
CALCULATED:
APPLYCONVERSION:
APPLYFORMAT:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiGetTableNonePost

Returns a query result in a table format in None mode.


/api/GetTableNone

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/GetTableNone"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKGETTABLENONECOMMAND body = ; // LKGETTABLENONECOMMAND | 
        try {
            apiInstance.apiGetTableNonePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiGetTableNonePost");
            e.printStackTrace();
        }
    }
}
LKGETTABLENONECOMMAND *body = ; //  (optional)

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

// Returns a query result in a table format in None mode.
[apiInstance apiGetTableNonePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKGETTABLENONECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiGetTableNonePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKGETTABLENONECOMMAND(); // LKGETTABLENONECOMMAND |  (optional) 

            try
            {
                // Returns a query result in a table format in None mode.
                apiInstance.apiGetTableNonePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiGetTableNonePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKGETTABLENONECOMMAND | 

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

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

eval { 
    $api_instance->apiGetTableNonePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiGetTableNonePost: $@\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.SendCommandApiApi()
body =  # LKGETTABLENONECOMMAND |  (optional)

try: 
    # Returns a query result in a table format in None mode.
    api_instance.api_get_table_none_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiGetTableNonePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
SELECT_CLAUSE:
SORT_CLAUSE:
DICT_CLAUSE:
ROWHEADERS:
REPEATVALUES:
CALCULATED:
APPLYCONVERSION:
APPLYFORMAT:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiGetTablePost

Returns a query result in a table format.


/api/GetTable

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/GetTable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKGETTABLECOMMAND body = ; // LKGETTABLECOMMAND | 
        try {
            apiInstance.apiGetTablePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiGetTablePost");
            e.printStackTrace();
        }
    }
}
LKGETTABLECOMMAND *body = ; //  (optional)

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

// Returns a query result in a table format.
[apiInstance apiGetTablePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKGETTABLECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiGetTablePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKGETTABLECOMMAND(); // LKGETTABLECOMMAND |  (optional) 

            try
            {
                // Returns a query result in a table format.
                apiInstance.apiGetTablePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiGetTablePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKGETTABLECOMMAND | 

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

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

eval { 
    $api_instance->apiGetTablePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiGetTablePost: $@\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.SendCommandApiApi()
body =  # LKGETTABLECOMMAND |  (optional)

try: 
    # Returns a query result in a table format.
    api_instance.api_get_table_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiGetTablePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
SELECT_CLAUSE:
SORT_CLAUSE:
DICT_CLAUSE:
ONLYVISIBLES:
ROWPROPERTIES:
USEPROPERTYNAMES:
ROWHEADERS:
REPEATVALUES:
CALCULATED:
APPLYCONVERSION:
APPLYFORMAT:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiGetTableSqlModePost

Returns a query result in a table format in SQL mode.


/api/GetTableSqlMode

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/GetTableSqlMode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKGETTABLESQLMODECOMMAND body = ; // LKGETTABLESQLMODECOMMAND | 
        try {
            apiInstance.apiGetTableSqlModePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiGetTableSqlModePost");
            e.printStackTrace();
        }
    }
}
LKGETTABLESQLMODECOMMAND *body = ; //  (optional)

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

// Returns a query result in a table format in SQL mode.
[apiInstance apiGetTableSqlModePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKGETTABLESQLMODECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiGetTableSqlModePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKGETTABLESQLMODECOMMAND(); // LKGETTABLESQLMODECOMMAND |  (optional) 

            try
            {
                // Returns a query result in a table format in SQL mode.
                apiInstance.apiGetTableSqlModePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiGetTableSqlModePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKGETTABLESQLMODECOMMAND | 

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

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

eval { 
    $api_instance->apiGetTableSqlModePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiGetTableSqlModePost: $@\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.SendCommandApiApi()
body =  # LKGETTABLESQLMODECOMMAND |  (optional)

try: 
    # Returns a query result in a table format in SQL mode.
    api_instance.api_get_table_sql_mode_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiGetTableSqlModePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
SELECT_CLAUSE:
SORT_CLAUSE:
DICT_CLAUSE:
ROWHEADERS:
CALCULATED:
APPLYCONVERSION:
APPLYFORMAT:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiGetVersionPost

Allows getting the server version.


/api/GetVersion

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/GetVersion"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKGETVERSIONCOMMAND body = ; // LKGETVERSIONCOMMAND | 
        try {
            apiInstance.apiGetVersionPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiGetVersionPost");
            e.printStackTrace();
        }
    }
}
LKGETVERSIONCOMMAND *body = ; //  (optional)

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

// Allows getting the server version.
[apiInstance apiGetVersionPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKGETVERSIONCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiGetVersionPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKGETVERSIONCOMMAND(); // LKGETVERSIONCOMMAND |  (optional) 

            try
            {
                // Allows getting the server version.
                apiInstance.apiGetVersionPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiGetVersionPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKGETVERSIONCOMMAND | 

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

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

eval { 
    $api_instance->apiGetVersionPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiGetVersionPost: $@\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.SendCommandApiApi()
body =  # LKGETVERSIONCOMMAND |  (optional)

try: 
    # Allows getting the server version.
    api_instance.api_get_version_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiGetVersionPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

This function returns the following information

  • LKMVCOMPONENTSVERSION: MV Components version.
  • LKSERVERVERSION: Linkar SERVER version.
  • LKCLIENTVERSION: Used client library version.
  • DATABASE: Database.
  • OS: Operating system.
  • DATEZERO: Date zero base in YYYYMMDD format.
  • DATEOUTPUTCONVERSION: Output conversion for date used by Linkar Schemas.
  • TIMEOUTPUTCONVERSION: Output conversion for time used by Linkar Schemas.
  • MVDATETIMESEPARATOR: DateTime used separator used by Linkar Schemas, for instance 18325,23000.
  • MVBOOLTRUE: Database used char for the Boolean true value used by Linkar Schemas.
  • MVBOOLFALSE: Database used char for the Boolean false value used by Linkar Schemas.
  • OUTPUTBOOLTRUE: Used char for the Boolean true value out of the database used by Linkar Schemas.
  • OUTPUTBOOLFALSE: Used char for the Boolean false value out of the database used by Linkar Schemas.
  • MVDECIMALSEPARATOR: Decimal separator in the database. May be point, comma or none when the database does not store decimal numbers. Used by Linkar Schemas.
  • OTHERLANGUAGES: Languages list separated by commas.
  • TABLEROWSEPARATOR: It is the decimal char that you use to separate the rows in the output table format. By default 11.
  • TABLECOLSEPARATOR: It is the decimal char that you use to separate the columns in the output table format. By default 9.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLKSchemasDictionariesPost

Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in Dictionaries mode.


/api/LKSchemasDictionaries

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LKSchemasDictionaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKSCHEMASDICTIONARIESCOMMAND body = ; // LKSCHEMASDICTIONARIESCOMMAND | 
        try {
            apiInstance.apiLKSchemasDictionariesPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLKSchemasDictionariesPost");
            e.printStackTrace();
        }
    }
}
LKSCHEMASDICTIONARIESCOMMAND *body = ; //  (optional)

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

// Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in Dictionaries mode.
[apiInstance apiLKSchemasDictionariesPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKSCHEMASDICTIONARIESCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLKSchemasDictionariesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKSCHEMASDICTIONARIESCOMMAND(); // LKSCHEMASDICTIONARIESCOMMAND |  (optional) 

            try
            {
                // Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in Dictionaries mode.
                apiInstance.apiLKSchemasDictionariesPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLKSchemasDictionariesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKSCHEMASDICTIONARIESCOMMAND | 

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

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

eval { 
    $api_instance->apiLKSchemasDictionariesPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLKSchemasDictionariesPost: $@\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.SendCommandApiApi()
body =  # LKSCHEMASDICTIONARIESCOMMAND |  (optional)

try: 
    # Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in Dictionaries mode.
    api_instance.api_lk_schemas_dictionaries_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLKSchemasDictionariesPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLkPropertiesDictionariesPost

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in Dictionaries Mode.


/api/LkPropertiesDictionaries

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LkPropertiesDictionaries"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKPROPERTIESDICTIONARIESCOMMAND body = ; // LKPROPERTIESDICTIONARIESCOMMAND | 
        try {
            apiInstance.apiLkPropertiesDictionariesPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLkPropertiesDictionariesPost");
            e.printStackTrace();
        }
    }
}
LKPROPERTIESDICTIONARIESCOMMAND *body = ; //  (optional)

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

// Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in Dictionaries Mode.
[apiInstance apiLkPropertiesDictionariesPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKPROPERTIESDICTIONARIESCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLkPropertiesDictionariesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKPROPERTIESDICTIONARIESCOMMAND(); // LKPROPERTIESDICTIONARIESCOMMAND |  (optional) 

            try
            {
                // Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in Dictionaries Mode.
                apiInstance.apiLkPropertiesDictionariesPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLkPropertiesDictionariesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKPROPERTIESDICTIONARIESCOMMAND | 

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

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

eval { 
    $api_instance->apiLkPropertiesDictionariesPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLkPropertiesDictionariesPost: $@\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.SendCommandApiApi()
body =  # LKPROPERTIESDICTIONARIESCOMMAND |  (optional)

try: 
    # Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in Dictionaries Mode.
    api_instance.api_lk_properties_dictionaries_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLkPropertiesDictionariesPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLkPropertiesPost

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries.


/api/LkProperties

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LkProperties"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKPROPERTIESCOMMAND body = ; // LKPROPERTIESCOMMAND | 
        try {
            apiInstance.apiLkPropertiesPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLkPropertiesPost");
            e.printStackTrace();
        }
    }
}
LKPROPERTIESCOMMAND *body = ; //  (optional)

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

// Returns the Schema properties list defined in Linkar Schemas or the file dictionaries.
[apiInstance apiLkPropertiesPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKPROPERTIESCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLkPropertiesPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKPROPERTIESCOMMAND(); // LKPROPERTIESCOMMAND |  (optional) 

            try
            {
                // Returns the Schema properties list defined in Linkar Schemas or the file dictionaries.
                apiInstance.apiLkPropertiesPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLkPropertiesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKPROPERTIESCOMMAND | 

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

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

eval { 
    $api_instance->apiLkPropertiesPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLkPropertiesPost: $@\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.SendCommandApiApi()
body =  # LKPROPERTIESCOMMAND |  (optional)

try: 
    # Returns the Schema properties list defined in Linkar Schemas or the file dictionaries.
    api_instance.api_lk_properties_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLkPropertiesPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
ONLYVISIBLES:
ROWPROPERTIES:
USEPROPERTYNAMES:
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLkPropertiesSqlModePost

Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in SQL mode.


/api/LkPropertiesSqlMode

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LkPropertiesSqlMode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKPROPERTIESSQLMODECOMMAND body = ; // LKPROPERTIESSQLMODECOMMAND | 
        try {
            apiInstance.apiLkPropertiesSqlModePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLkPropertiesSqlModePost");
            e.printStackTrace();
        }
    }
}
LKPROPERTIESSQLMODECOMMAND *body = ; //  (optional)

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

// Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in SQL mode.
[apiInstance apiLkPropertiesSqlModePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKPROPERTIESSQLMODECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLkPropertiesSqlModePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKPROPERTIESSQLMODECOMMAND(); // LKPROPERTIESSQLMODECOMMAND |  (optional) 

            try
            {
                // Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in SQL mode.
                apiInstance.apiLkPropertiesSqlModePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLkPropertiesSqlModePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKPROPERTIESSQLMODECOMMAND | 

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

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

eval { 
    $api_instance->apiLkPropertiesSqlModePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLkPropertiesSqlModePost: $@\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.SendCommandApiApi()
body =  # LKPROPERTIESSQLMODECOMMAND |  (optional)

try: 
    # Returns the Schema properties list defined in Linkar Schemas or the file dictionaries in SQL mode.
    api_instance.api_lk_properties_sql_mode_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLkPropertiesSqlModePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLkSchemasPost

Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files.


/api/LkSchemas

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LkSchemas"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKSCHEMASCOMMAND body = ; // LKSCHEMASCOMMAND | 
        try {
            apiInstance.apiLkSchemasPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLkSchemasPost");
            e.printStackTrace();
        }
    }
}
LKSCHEMASCOMMAND *body = ; //  (optional)

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

// Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files.
[apiInstance apiLkSchemasPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKSCHEMASCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLkSchemasPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKSCHEMASCOMMAND(); // LKSCHEMASCOMMAND |  (optional) 

            try
            {
                // Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files.
                apiInstance.apiLkSchemasPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLkSchemasPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKSCHEMASCOMMAND | 

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

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

eval { 
    $api_instance->apiLkSchemasPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLkSchemasPost: $@\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.SendCommandApiApi()
body =  # LKSCHEMASCOMMAND |  (optional)

try: 
    # Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files.
    api_instance.api_lk_schemas_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLkSchemasPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
ONLYVISIBLES:
ROWPROPERTIES:
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiLkSchemasSqlModePost

Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in SQL mode.


/api/LkSchemasSqlMode

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/LkSchemasSqlMode"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKSCHEMASSQLMODECOMMAND body = ; // LKSCHEMASSQLMODECOMMAND | 
        try {
            apiInstance.apiLkSchemasSqlModePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiLkSchemasSqlModePost");
            e.printStackTrace();
        }
    }
}
LKSCHEMASSQLMODECOMMAND *body = ; //  (optional)

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

// Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in SQL mode.
[apiInstance apiLkSchemasSqlModePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKSCHEMASSQLMODECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiLkSchemasSqlModePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKSCHEMASSQLMODECOMMAND(); // LKSCHEMASSQLMODECOMMAND |  (optional) 

            try
            {
                // Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in SQL mode.
                apiInstance.apiLkSchemasSqlModePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiLkSchemasSqlModePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKSCHEMASSQLMODECOMMAND | 

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

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

eval { 
    $api_instance->apiLkSchemasSqlModePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiLkSchemasSqlModePost: $@\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.SendCommandApiApi()
body =  # LKSCHEMASSQLMODECOMMAND |  (optional)

try: 
    # Returns a list of all the Schemas defined in Linkar Schemas, or the EntryPoint account data files in SQL mode.
    api_instance.api_lk_schemas_sql_mode_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiLkSchemasSqlModePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

TABLE output format uses the defined control characters in Linkar Manager EntryPoints Parameters, Table Row Separator and Column Row Separator. By default:

  • TAB char (9) for columns.
  • VT char (11) for rows.
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
ROWHEADERS:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiNewCustomPost

Creates one or several records of a file. Generate Custom item IDs.


/api/NewCustom

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/NewCustom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKNEWCUSTOMCOMMAND body = ; // LKNEWCUSTOMCOMMAND | 
        try {
            apiInstance.apiNewCustomPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiNewCustomPost");
            e.printStackTrace();
        }
    }
}
LKNEWCUSTOMCOMMAND *body = ; //  (optional)

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

// Creates one or several records of a file. Generate Custom item IDs.
[apiInstance apiNewCustomPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKNEWCUSTOMCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiNewCustomPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKNEWCUSTOMCOMMAND(); // LKNEWCUSTOMCOMMAND |  (optional) 

            try
            {
                // Creates one or several records of a file. Generate Custom item IDs.
                apiInstance.apiNewCustomPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiNewCustomPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKNEWCUSTOMCOMMAND | 

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

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

eval { 
    $api_instance->apiNewCustomPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiNewCustomPost: $@\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.SendCommandApiApi()
body =  # LKNEWCUSTOMCOMMAND |  (optional)

try: 
    # Creates one or several records of a file. Generate Custom item IDs.
    api_instance.api_new_custom_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiNewCustomPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID must be empty and the others tags of RECORD always must be specified.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,NEW_RECORD_ID_TYPE,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
CUSTOM_VARS:
OUTPUT_FORMAT:
NEW_RECORD_ID_TYPE:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiNewLinkarPost

Creates one or several records of a file. Generate Linkar item IDs.


/api/NewLinkar

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/NewLinkar"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKNEWLINKARCOMMAND body = ; // LKNEWLINKARCOMMAND | 
        try {
            apiInstance.apiNewLinkarPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiNewLinkarPost");
            e.printStackTrace();
        }
    }
}
LKNEWLINKARCOMMAND *body = ; //  (optional)

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

// Creates one or several records of a file. Generate Linkar item IDs.
[apiInstance apiNewLinkarPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKNEWLINKARCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiNewLinkarPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKNEWLINKARCOMMAND(); // LKNEWLINKARCOMMAND |  (optional) 

            try
            {
                // Creates one or several records of a file. Generate Linkar item IDs.
                apiInstance.apiNewLinkarPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiNewLinkarPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKNEWLINKARCOMMAND | 

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

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

eval { 
    $api_instance->apiNewLinkarPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiNewLinkarPost: $@\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.SendCommandApiApi()
body =  # LKNEWLINKARCOMMAND |  (optional)

try: 
    # Creates one or several records of a file. Generate Linkar item IDs.
    api_instance.api_new_linkar_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiNewLinkarPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID must be empty and the others tags of RECORD always must be specified.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,NEW_RECORD_ID_TYPE,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
CUSTOM_VARS:
OUTPUT_FORMAT:
NEW_RECORD_ID_TYPE:
NEW_RECORD_ID_FORMAT_SPEC:
NEW_RECORD_ID_PREFIX:
NEW_RECORD_ID_SEPARATOR:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiNewPost

Creates one or several records of a file.


/api/New

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/New"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKNEWCOMMAND body = ; // LKNEWCOMMAND | 
        try {
            apiInstance.apiNewPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiNewPost");
            e.printStackTrace();
        }
    }
}
LKNEWCOMMAND *body = ; //  (optional)

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

// Creates one or several records of a file.
[apiInstance apiNewPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKNEWCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiNewPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKNEWCOMMAND(); // LKNEWCOMMAND |  (optional) 

            try
            {
                // Creates one or several records of a file.
                apiInstance.apiNewPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiNewPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKNEWCOMMAND | 

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

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

eval { 
    $api_instance->apiNewPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiNewPost: $@\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.SendCommandApiApi()
body =  # LKNEWCOMMAND |  (optional)

try: 
    # Creates one or several records of a file.
    api_instance.api_new_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiNewPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID and the others tags of RECORD always must be specified.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiNewRandomPost

Creates one or several records of a file. Generate Random item IDs.


/api/NewRandom

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/NewRandom"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKNEWRANDOMCOMMAND body = ; // LKNEWRANDOMCOMMAND | 
        try {
            apiInstance.apiNewRandomPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiNewRandomPost");
            e.printStackTrace();
        }
    }
}
LKNEWRANDOMCOMMAND *body = ; //  (optional)

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

// Creates one or several records of a file. Generate Random item IDs.
[apiInstance apiNewRandomPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKNEWRANDOMCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiNewRandomPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKNEWRANDOMCOMMAND(); // LKNEWRANDOMCOMMAND |  (optional) 

            try
            {
                // Creates one or several records of a file. Generate Random item IDs.
                apiInstance.apiNewRandomPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiNewRandomPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKNEWRANDOMCOMMAND | 

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

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

eval { 
    $api_instance->apiNewRandomPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiNewRandomPost: $@\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.SendCommandApiApi()
body =  # LKNEWRANDOMCOMMAND |  (optional)

try: 
    # Creates one or several records of a file. Generate Random item IDs.
    api_instance.api_new_random_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiNewRandomPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID must be empty and the others tags of RECORD always must be specified.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,NEW_RECORD_ID_TYPE,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
CUSTOM_VARS:
OUTPUT_FORMAT:
NEW_RECORD_ID_TYPE:
NEW_RECORD_ID_NUMERIC:
NEW_RECORD_ID_LENGTH:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiReadPost

Reads one or several records of a file.


/api/Read

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Read"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKREADCOMMAND body = ; // LKREADCOMMAND | 
        try {
            apiInstance.apiReadPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiReadPost");
            e.printStackTrace();
        }
    }
}
LKREADCOMMAND *body = ; //  (optional)

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

// Reads one or several records of a file.
[apiInstance apiReadPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKREADCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiReadPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKREADCOMMAND(); // LKREADCOMMAND |  (optional) 

            try
            {
                // Reads one or several records of a file.
                apiInstance.apiReadPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiReadPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKREADCOMMAND | 

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

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

eval { 
    $api_instance->apiReadPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiReadPost: $@\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.SendCommandApiApi()
body =  # LKREADCOMMAND |  (optional)

try: 
    # Reads one or several records of a file.
    api_instance.api_read_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiReadPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID always must be specified.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS
FILE_NAME:
RECORDS:
DICT_CLAUSE:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiResetCommonBlocksPost

Resets the COMMON variables with the 100 most used files


/api/ResetCommonBlocks

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/ResetCommonBlocks"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKRESETCOMMONBLOCKSCOMMAND body = ; // LKRESETCOMMONBLOCKSCOMMAND | 
        try {
            apiInstance.apiResetCommonBlocksPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiResetCommonBlocksPost");
            e.printStackTrace();
        }
    }
}
LKRESETCOMMONBLOCKSCOMMAND *body = ; //  (optional)

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

// Resets the COMMON variables with the 100 most used files
[apiInstance apiResetCommonBlocksPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKRESETCOMMONBLOCKSCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiResetCommonBlocksPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKRESETCOMMONBLOCKSCOMMAND(); // LKRESETCOMMONBLOCKSCOMMAND |  (optional) 

            try
            {
                // Resets the COMMON variables with the 100 most used files
                apiInstance.apiResetCommonBlocksPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiResetCommonBlocksPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKRESETCOMMONBLOCKSCOMMAND | 

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

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

eval { 
    $api_instance->apiResetCommonBlocksPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiResetCommonBlocksPost: $@\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.SendCommandApiApi()
body =  # LKRESETCOMMONBLOCKSCOMMAND |  (optional)

try: 
    # Resets the COMMON variables with the 100 most used files
    api_instance.api_reset_common_blocks_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiResetCommonBlocksPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiSelectPost

Executes a Query in the Database.


/api/Select

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Select"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKSELECTCOMMAND body = ; // LKSELECTCOMMAND | 
        try {
            apiInstance.apiSelectPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiSelectPost");
            e.printStackTrace();
        }
    }
}
LKSELECTCOMMAND *body = ; //  (optional)

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

// Executes a Query in the Database.
[apiInstance apiSelectPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKSELECTCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiSelectPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKSELECTCOMMAND(); // LKSELECTCOMMAND |  (optional) 

            try
            {
                // Executes a Query in the Database.
                apiInstance.apiSelectPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiSelectPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKSELECTCOMMAND | 

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

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

eval { 
    $api_instance->apiSelectPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiSelectPost: $@\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.SendCommandApiApi()
body =  # LKSELECTCOMMAND |  (optional)

try: 
    # Executes a Query in the Database.
    api_instance.api_select_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiSelectPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

In the PRESELECT_CLAUSE tag these operations can be carried out before executing the Select statement:

  • Previously call to a saved list with the GET.LIST command to use it in the Main Select input
  • Make a previous Select to use the result as the Main Select input, with the SELECT or SSELECT commands.In this case the entire sentence must be indicated in the PreselectClause. For example:SSELECT LK.ORDERS WITH CUSTOMER = '1'
  • Exploit a Main File index to use the result as a Main Select input, with the SELECTINDEX command. The syntax for all the databases is SELECTINDEX index.name.value. For example SELECTINDEX ITEM,"101691"
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME
FILE_NAME:
SELECT_CLAUSE:
SORT_CLAUSE:
DICT_CLAUSE:
PRESELECT_CLAUSE:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
ONLY_RECORD_ID:
PAGINATION:
PAGE_NUMBER:
RECORDS_FOR_PAGE:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiSubroutinePost

Executes a subroutine.


/api/Subroutine

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Subroutine"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKSUBROUTINECOMMAND body = ; // LKSUBROUTINECOMMAND | 
        try {
            apiInstance.apiSubroutinePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiSubroutinePost");
            e.printStackTrace();
        }
    }
}
LKSUBROUTINECOMMAND *body = ; //  (optional)

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

// Executes a subroutine.
[apiInstance apiSubroutinePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKSUBROUTINECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiSubroutinePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKSUBROUTINECOMMAND(); // LKSUBROUTINECOMMAND |  (optional) 

            try
            {
                // Executes a subroutine.
                apiInstance.apiSubroutinePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiSubroutinePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKSUBROUTINECOMMAND | 

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

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

eval { 
    $api_instance->apiSubroutinePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiSubroutinePost: $@\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.SendCommandApiApi()
body =  # LKSUBROUTINECOMMAND |  (optional)

try: 
    # Executes a subroutine.
    api_instance.api_subroutine_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiSubroutinePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{
Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: ARGUMENTS,NUMBER_OF_ARGUMENTS,SUBROUTINE_NAME
SUBROUTINE_NAME:
NUMBER_OF_ARGUMENTS:
ARGUMENTS:
CUSTOM_VARS:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiUpdatePartialPost

Update partially one or several records of a file.


/api/UpdatePartial

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/UpdatePartial"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKUPDATEPARTIALCOMMAND body = ; // LKUPDATEPARTIALCOMMAND | 
        try {
            apiInstance.apiUpdatePartialPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiUpdatePartialPost");
            e.printStackTrace();
        }
    }
}
LKUPDATEPARTIALCOMMAND *body = ; //  (optional)

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

// Update partially one or several records of a file.
[apiInstance apiUpdatePartialPostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKUPDATEPARTIALCOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiUpdatePartialPost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKUPDATEPARTIALCOMMAND(); // LKUPDATEPARTIALCOMMAND |  (optional) 

            try
            {
                // Update partially one or several records of a file.
                apiInstance.apiUpdatePartialPost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiUpdatePartialPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKUPDATEPARTIALCOMMAND | 

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

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

eval { 
    $api_instance->apiUpdatePartialPost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiUpdatePartialPost: $@\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.SendCommandApiApi()
body =  # LKUPDATEPARTIALCOMMAND |  (optional)

try: 
    # Update partially one or several records of a file.
    api_instance.api_update_partial_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiUpdatePartialPost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID and the others tags of RECORD always must be specified. But the ORIGINAL_RECORD not always. When OPTIMISTIC_LOCK tag is set to true, a copy of the record must be provided before the modification (ORIGINAL_RECORD tag) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the modification, reads the record and compares it with the copy in ORIGINAL_RECORD tag, if they are equal the modified record is executed. But if they are not equal, it means that the record has been modified by other user and its modification will not be saved. The record will have to be read, modified and saved again.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
OPTIMISTIC_LOCK:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request


apiUpdatePost

Update one or several records of a file.


/api/Update

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json,application/xml"\
"//api/Update"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SendCommandApiApi;

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

public class SendCommandApiApiExample {

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

public class SendCommandApiApiExample {

    public static void main(String[] args) {
        SendCommandApiApi apiInstance = new SendCommandApiApi();
        LKUPDATECOMMAND body = ; // LKUPDATECOMMAND | 
        try {
            apiInstance.apiUpdatePost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling SendCommandApiApi#apiUpdatePost");
            e.printStackTrace();
        }
    }
}
LKUPDATECOMMAND *body = ; //  (optional)

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

// Update one or several records of a file.
[apiInstance apiUpdatePostWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LinkarRestApi230 = require('linkar_rest_api_230');

var api = new LinkarRestApi230.SendCommandApiApi()
var opts = { 
  'body':  // {{LKUPDATECOMMAND}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiUpdatePost(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new SendCommandApiApi();
            var body = new LKUPDATECOMMAND(); // LKUPDATECOMMAND |  (optional) 

            try
            {
                // Update one or several records of a file.
                apiInstance.apiUpdatePost(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SendCommandApiApi.apiUpdatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSendCommandApiApi();
$body = ; // LKUPDATECOMMAND | 

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

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

eval { 
    $api_instance->apiUpdatePost(body => $body);
};
if ($@) {
    warn "Exception when calling SendCommandApiApi->apiUpdatePost: $@\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.SendCommandApiApi()
body =  # LKUPDATECOMMAND |  (optional)

try: 
    # Update one or several records of a file.
    api_instance.api_update_post(body=body)
except ApiException as e:
    print("Exception when calling SendCommandApiApi->apiUpdatePost: %s\n" % e)

Parameters

Body parameters
Name Description
body
{

Inside the RECORD tag, the LKITEMID and the others tags of RECORD always must be specified. But the ORIGINAL_RECORD not always. When OPTIMISTIC_LOCK tag is set to true, a copy of the record must be provided before the modification (ORIGINAL_RECORD tag) to use the Optimistic Lock technique. This copy can be obtained from a previous Read operation. The database, before executing the modification, reads the record and compares it with the copy in ORIGINAL_RECORD tag, if they are equal the modified record is executed. But if they are not equal, it means that the record has been modified by other user and its modification will not be saved. The record will have to be read, modified and saved again.

Required: APIKEY,DATA
APIKEY:
string

API Key is necessary to perform the operation.

example: MyAPIKey
DATA:
{
Required: FILE_NAME,RECORDS
FILE_NAME:
RECORDS:
READ_AFTER:
CALCULATED:
CONVERSION:
FORMAT_SPEC:
ORIGINAL_RECORDS:
OPTIMISTIC_LOCK:
CUSTOM_VARS:
OUTPUT_FORMAT:
}
LANGUAGE:
string

Directs DBMS to respond with errors in the specified language. Error messages are in English by default, and can be customized and translated.

FREETEXT:
string

Free text that displays in Linkar MANAGER, in the Client Sessions monitor. This can help to identify the source of the request. Examples: "ERP1", "Android v1.3", "Client245".

}

Responses

Status: 200 - Success

Status: 400 - Error:Bad Request