Alamut Visual Plus API

Open

Open a file with Alamut Visual Plus

Open a local or remote file (BAM, CRAM or Sanger) with Alamut Visual Plus


/open

Usage and SDK Samples

curl -X GET "http://127.0.0.1:10000/open?institution=&apikey=&filetype=&path="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OpenApi;

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

public class OpenApiExample {

    public static void main(String[] args) {
        
        OpenApi apiInstance = new OpenApi();
        String apikey = apikey_example; // String | API key
        String filetype = filetype_example; // String | File type (BAM, CRAM, Sanger)
        String path = path_example; // String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
        String institution = institution_example; // String | Institution ID. By default, the Alamut user's institution is used.
        try {
            apiInstance.openGet(apikey, filetype, path, institution);
        } catch (ApiException e) {
            System.err.println("Exception when calling OpenApi#openGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OpenApi;

public class OpenApiExample {

    public static void main(String[] args) {
        OpenApi apiInstance = new OpenApi();
        String apikey = apikey_example; // String | API key
        String filetype = filetype_example; // String | File type (BAM, CRAM, Sanger)
        String path = path_example; // String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
        String institution = institution_example; // String | Institution ID. By default, the Alamut user's institution is used.
        try {
            apiInstance.openGet(apikey, filetype, path, institution);
        } catch (ApiException e) {
            System.err.println("Exception when calling OpenApi#openGet");
            e.printStackTrace();
        }
    }
}
String *apikey = apikey_example; // API key
String *filetype = filetype_example; // File type (BAM, CRAM, Sanger)
String *path = path_example; // Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
String *institution = institution_example; // Institution ID. By default, the Alamut user's institution is used. (optional)

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

// Open a file with Alamut Visual Plus
[apiInstance openGetWith:apikey
    filetype:filetype
    path:path
    institution:institution
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AlamutVisualPlusApi = require('alamut_visual_plus_api');

var api = new AlamutVisualPlusApi.OpenApi()

var apikey = apikey_example; // {String} API key

var filetype = filetype_example; // {String} File type (BAM, CRAM, Sanger)

var path = path_example; // {String} Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)

var opts = { 
  'institution': institution_example // {String} Institution ID. By default, the Alamut user's institution is used.
};

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

namespace Example
{
    public class openGetExample
    {
        public void main()
        {
            
            var apiInstance = new OpenApi();
            var apikey = apikey_example;  // String | API key
            var filetype = filetype_example;  // String | File type (BAM, CRAM, Sanger)
            var path = path_example;  // String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
            var institution = institution_example;  // String | Institution ID. By default, the Alamut user's institution is used. (optional) 

            try
            {
                // Open a file with Alamut Visual Plus
                apiInstance.openGet(apikey, filetype, path, institution);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OpenApi.openGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\OpenApi();
$apikey = apikey_example; // String | API key
$filetype = filetype_example; // String | File type (BAM, CRAM, Sanger)
$path = path_example; // String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
$institution = institution_example; // String | Institution ID. By default, the Alamut user's institution is used.

try {
    $api_instance->openGet($apikey, $filetype, $path, $institution);
} catch (Exception $e) {
    echo 'Exception when calling OpenApi->openGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OpenApi;

my $api_instance = WWW::SwaggerClient::OpenApi->new();
my $apikey = apikey_example; # String | API key
my $filetype = filetype_example; # String | File type (BAM, CRAM, Sanger)
my $path = path_example; # String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
my $institution = institution_example; # String | Institution ID. By default, the Alamut user's institution is used.

eval { 
    $api_instance->openGet(apikey => $apikey, filetype => $filetype, path => $path, institution => $institution);
};
if ($@) {
    warn "Exception when calling OpenApi->openGet: $@\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.OpenApi()
apikey = apikey_example # String | API key
filetype = filetype_example # String | File type (BAM, CRAM, Sanger)
path = path_example # String | Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
institution = institution_example # String | Institution ID. By default, the Alamut user's institution is used. (optional)

try: 
    # Open a file with Alamut Visual Plus
    api_instance.open_get(apikey, filetype, path, institution=institution)
except ApiException as e:
    print("Exception when calling OpenApi->openGet: %s\n" % e)

Parameters

Query parameters
Name Description
institution
String
Institution ID. By default, the Alamut user's institution is used.
apikey*
String
API key
Required
filetype*
String
File type (BAM, CRAM, Sanger)
Required
path*
String
Local path or URL of the file, in the percent encoding format (see https://www.urlencoder.org)
Required

Responses

Status: 200 - Success

Status: 400 - Bad Request: could not open file

Status: 401 - Unauthorized: API key error


Version

Get the name and version of the application


/version

Usage and SDK Samples

curl -X GET "http://127.0.0.1:10000/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VersionApi;

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

public class VersionApiExample {

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

public class VersionApiExample {

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

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

// Get the name and version of the application
[apiInstance versionGetWithCompletionHandler: 
              ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AlamutVisualPlusApi = require('alamut_visual_plus_api');

var api = new AlamutVisualPlusApi.VersionApi()

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

namespace Example
{
    public class versionGetExample
    {
        public void main()
        {
            
            var apiInstance = new VersionApi();

            try
            {
                // Get the name and version of the application
                Object result = apiInstance.versionGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VersionApi.versionGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    my $result = $api_instance->versionGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VersionApi->versionGet: $@\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.VersionApi()

try: 
    # Get the name and version of the application
    api_response = api_instance.version_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VersionApi->versionGet: %s\n" % e)

Parameters

Responses

Status: 200 - Success: name and version of the application