VAdmin API 1.0

LoadPlansApi

getAllAsync

Get list of load plans

/api/databases/{databaseId}/loadplans

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanApiModel] result = apiInstance.getAllAsync(databaseId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAllAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanApiModel] result = apiInstance.getAllAsync(databaseId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAllAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Get list of load plans
[apiInstance getAllAsyncWith:databaseId
    xApiVersion:xApiVersion
              completionHandler: ^(array[LoadPlanApiModel] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

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

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Get list of load plans
                array[LoadPlanApiModel] result = apiInstance.getAllAsync(databaseId, xApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.getAllAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$xApiVersion = xApiVersion_example; // String | 

try {
    $result = $api_instance->getAllAsync($databaseId, $xApiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->getAllAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getAllAsync(databaseId => $databaseId, xApiVersion => $xApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->getAllAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Get list of load plans
    api_response = api_instance.get_all_async(databaseId, xApiVersion=xApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->getAllAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Returns list of load plans

Schema

Status: 404 - Returns error if connection or database does not exist

Schema

getAllStatusesAsync

Get list of load plans with status

/api/databases/{databaseId}/loadplans/all/status

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/all/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanWithStatusApiModel] result = apiInstance.getAllStatusesAsync(databaseId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAllStatusesAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanWithStatusApiModel] result = apiInstance.getAllStatusesAsync(databaseId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAllStatusesAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Get list of load plans with status
[apiInstance getAllStatusesAsyncWith:databaseId
    xApiVersion:xApiVersion
              completionHandler: ^(array[LoadPlanWithStatusApiModel] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

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

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Get list of load plans with status
                array[LoadPlanWithStatusApiModel] result = apiInstance.getAllStatusesAsync(databaseId, xApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.getAllStatusesAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$xApiVersion = xApiVersion_example; // String | 

try {
    $result = $api_instance->getAllStatusesAsync($databaseId, $xApiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->getAllStatusesAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getAllStatusesAsync(databaseId => $databaseId, xApiVersion => $xApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->getAllStatusesAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Get list of load plans with status
    api_response = api_instance.get_all_statuses_async(databaseId, xApiVersion=xApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->getAllStatusesAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Returns list of load plans with status

Schema

Status: 404 - Returns error if connection or database does not exist

Schema

getAsync

Get load plan with the id given

/api/databases/{databaseId}/loadplans/{loadPlanId}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/{loadPlanId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            LoadPlanApiModel result = apiInstance.getAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            LoadPlanApiModel result = apiInstance.getAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
Integer *loadPlanId = 56; // Load plan id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Get load plan with the id given
[apiInstance getAsyncWith:databaseId
    loadPlanId:loadPlanId
    xApiVersion:xApiVersion
              completionHandler: ^(LoadPlanApiModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var loadPlanId = 56; // {Integer} Load plan id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

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

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var loadPlanId = 56;  // Integer | Load plan id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Get load plan with the id given
                LoadPlanApiModel result = apiInstance.getAsync(databaseId, loadPlanId, xApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.getAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$loadPlanId = 56; // Integer | Load plan id
$xApiVersion = xApiVersion_example; // String | 

try {
    $result = $api_instance->getAsync($databaseId, $loadPlanId, $xApiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->getAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $loadPlanId = 56; # Integer | Load plan id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getAsync(databaseId => $databaseId, loadPlanId => $loadPlanId, xApiVersion => $xApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->getAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
loadPlanId = 56 # Integer | Load plan id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Get load plan with the id given
    api_response = api_instance.get_async(databaseId, loadPlanId, xApiVersion=xApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->getAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required
loadPlanId*	Integer (int32) Load plan id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Returns load plan

Schema

Status: 404 - Returns error if сonnection, database or load plan does not exist

Schema

getStatusAsync

Get status of load plan

/api/databases/{databaseId}/loadplans/{loadPlanId}/status

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/{loadPlanId}/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            LoadPlanStatusApiModel result = apiInstance.getStatusAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getStatusAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            LoadPlanStatusApiModel result = apiInstance.getStatusAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getStatusAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
Integer *loadPlanId = 56; // Load plan id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Get status of load plan
[apiInstance getStatusAsyncWith:databaseId
    loadPlanId:loadPlanId
    xApiVersion:xApiVersion
              completionHandler: ^(LoadPlanStatusApiModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var loadPlanId = 56; // {Integer} Load plan id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

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

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var loadPlanId = 56;  // Integer | Load plan id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Get status of load plan
                LoadPlanStatusApiModel result = apiInstance.getStatusAsync(databaseId, loadPlanId, xApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.getStatusAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$loadPlanId = 56; // Integer | Load plan id
$xApiVersion = xApiVersion_example; // String | 

try {
    $result = $api_instance->getStatusAsync($databaseId, $loadPlanId, $xApiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->getStatusAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $loadPlanId = 56; # Integer | Load plan id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getStatusAsync(databaseId => $databaseId, loadPlanId => $loadPlanId, xApiVersion => $xApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->getStatusAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
loadPlanId = 56 # Integer | Load plan id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Get status of load plan
    api_response = api_instance.get_status_async(databaseId, loadPlanId, xApiVersion=xApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->getStatusAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required
loadPlanId*	Integer (int32) Load plan id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Returns status

Schema

Status: 404 - Returns error if сonnection, database or load plan does not exist

Schema

getStepsAsync

Get steps of load plan

/api/databases/{databaseId}/loadplans/{loadPlanId}/steps

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/{loadPlanId}/steps"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanStepApiModel] result = apiInstance.getStepsAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getStepsAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            array[LoadPlanStepApiModel] result = apiInstance.getStepsAsync(databaseId, loadPlanId, xApiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#getStepsAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
Integer *loadPlanId = 56; // Load plan id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Get steps of load plan
[apiInstance getStepsAsyncWith:databaseId
    loadPlanId:loadPlanId
    xApiVersion:xApiVersion
              completionHandler: ^(array[LoadPlanStepApiModel] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var loadPlanId = 56; // {Integer} Load plan id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

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

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var loadPlanId = 56;  // Integer | Load plan id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Get steps of load plan
                array[LoadPlanStepApiModel] result = apiInstance.getStepsAsync(databaseId, loadPlanId, xApiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.getStepsAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$loadPlanId = 56; // Integer | Load plan id
$xApiVersion = xApiVersion_example; // String | 

try {
    $result = $api_instance->getStepsAsync($databaseId, $loadPlanId, $xApiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->getStepsAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $loadPlanId = 56; # Integer | Load plan id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    my $result = $api_instance->getStepsAsync(databaseId => $databaseId, loadPlanId => $loadPlanId, xApiVersion => $xApiVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->getStepsAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
loadPlanId = 56 # Integer | Load plan id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Get steps of load plan
    api_response = api_instance.get_steps_async(databaseId, loadPlanId, xApiVersion=xApiVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->getStepsAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required
loadPlanId*	Integer (int32) Load plan id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Returns list of steps

Schema

Status: 404 - Returns error if сonnection, database or load plan does not exist

Schema

startAsync

Start load plan

/api/databases/{databaseId}/loadplans/{loadPlanId}/start

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/{loadPlanId}/start"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            apiInstance.startAsync(databaseId, loadPlanId, xApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#startAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            apiInstance.startAsync(databaseId, loadPlanId, xApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#startAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
Integer *loadPlanId = 56; // Load plan id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Start load plan
[apiInstance startAsyncWith:databaseId
    loadPlanId:loadPlanId
    xApiVersion:xApiVersion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var loadPlanId = 56; // {Integer} Load plan id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startAsync(databaseId, loadPlanId, opts, callback);

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var loadPlanId = 56;  // Integer | Load plan id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Start load plan
                apiInstance.startAsync(databaseId, loadPlanId, xApiVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.startAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$loadPlanId = 56; // Integer | Load plan id
$xApiVersion = xApiVersion_example; // String | 

try {
    $api_instance->startAsync($databaseId, $loadPlanId, $xApiVersion);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->startAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $loadPlanId = 56; # Integer | Load plan id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    $api_instance->startAsync(databaseId => $databaseId, loadPlanId => $loadPlanId, xApiVersion => $xApiVersion);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->startAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
loadPlanId = 56 # Integer | Load plan id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Start load plan
    api_instance.start_async(databaseId, loadPlanId, xApiVersion=xApiVersion)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->startAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required
loadPlanId*	Integer (int32) Load plan id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Success

Status: 400 - Returns error that another job for load plan is already in progress

Schema

Status: 404 - Returns error if сonnection, database or load plan does not exist

Schema

stopAsync

Stop load plan

/api/databases/{databaseId}/loadplans/{loadPlanId}/stop

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/vqadmin/api/databases/{databaseId}/loadplans/{loadPlanId}/stop"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoadPlansApiApi;

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

public class LoadPlansApiApiExample {

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

        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            apiInstance.stopAsync(databaseId, loadPlanId, xApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#stopAsync");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.LoadPlansApiApi;

public class LoadPlansApiApiExample {

    public static void main(String[] args) {
        LoadPlansApiApi apiInstance = new LoadPlansApiApi();
        String databaseId = databaseId_example; // String | Database id
        Integer loadPlanId = 56; // Integer | Load plan id
        String xApiVersion = xApiVersion_example; // String | 
        try {
            apiInstance.stopAsync(databaseId, loadPlanId, xApiVersion);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoadPlansApiApi#stopAsync");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

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

String *databaseId = databaseId_example; // Database id
Integer *loadPlanId = 56; // Load plan id
String *xApiVersion = xApiVersion_example; //  (optional)

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

// Stop load plan
[apiInstance stopAsyncWith:databaseId
    loadPlanId:loadPlanId
    xApiVersion:xApiVersion
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var VAdminApi10 = require('v_admin_api_10');
var defaultClient = VAdminApi10.ApiClient.instance;

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

var api = new VAdminApi10.LoadPlansApiApi()

var databaseId = databaseId_example; // {String} Database id

var loadPlanId = 56; // {Integer} Load plan id

var opts = { 
  'xApiVersion': xApiVersion_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopAsync(databaseId, loadPlanId, opts, callback);

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

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

            var apiInstance = new LoadPlansApiApi();
            var databaseId = databaseId_example;  // String | Database id
            var loadPlanId = 56;  // Integer | Load plan id
            var xApiVersion = xApiVersion_example;  // String |  (optional) 

            try
            {
                // Stop load plan
                apiInstance.stopAsync(databaseId, loadPlanId, xApiVersion);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoadPlansApiApi.stopAsync: " + e.Message );
            }
        }
    }
}

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

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

$api_instance = new Swagger\Client\Api\LoadPlansApiApi();
$databaseId = databaseId_example; // String | Database id
$loadPlanId = 56; // Integer | Load plan id
$xApiVersion = xApiVersion_example; // String | 

try {
    $api_instance->stopAsync($databaseId, $loadPlanId, $xApiVersion);
} catch (Exception $e) {
    echo 'Exception when calling LoadPlansApiApi->stopAsync: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LoadPlansApiApi;

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

my $api_instance = WWW::SwaggerClient::LoadPlansApiApi->new();
my $databaseId = databaseId_example; # String | Database id
my $loadPlanId = 56; # Integer | Load plan id
my $xApiVersion = xApiVersion_example; # String | 

eval { 
    $api_instance->stopAsync(databaseId => $databaseId, loadPlanId => $loadPlanId, xApiVersion => $xApiVersion);
};
if ($@) {
    warn "Exception when calling LoadPlansApiApi->stopAsync: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = swagger_client.LoadPlansApiApi()
databaseId = databaseId_example # String | Database id
loadPlanId = 56 # Integer | Load plan id
xApiVersion = xApiVersion_example # String |  (optional)

try: 
    # Stop load plan
    api_instance.stop_async(databaseId, loadPlanId, xApiVersion=xApiVersion)
except ApiException as e:
    print("Exception when calling LoadPlansApiApi->stopAsync: %s\n" % e)

Parameters

Path parameters

Name	Description
databaseId*	String Database id Required
loadPlanId*	Integer (int32) Load plan id Required

Header parameters

Name	Description
x-api-version	String

Responses

Status: 200 - Success

Status: 404 - Returns error if сonnection, database or load plan does not exist

Schema

VAdmin API 1.0

API and SDK Documentation

LoadPlansApi

getAllAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns list of load plans

Status: 404 - Returns error if connection or database does not exist

getAllStatusesAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns list of load plans with status

Status: 404 - Returns error if connection or database does not exist

getAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns load plan

Status: 404 - Returns error if сonnection, database or load plan does not exist

getStatusAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns status

Status: 404 - Returns error if сonnection, database or load plan does not exist

getStepsAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Returns list of steps

Status: 404 - Returns error if сonnection, database or load plan does not exist

startAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 400 - Returns error that another job for load plan is already in progress

Status: 404 - Returns error if сonnection, database or load plan does not exist

stopAsync

Usage and SDK Samples

Parameters

Responses

Status: 200 - Success

Status: 404 - Returns error if сonnection, database or load plan does not exist