Curio Genomics Services API

Projects

createProject

Create a project

Create a new project within a given organization


/projects

Usage and SDK Samples

curl -X POST \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.curiogenomics.com/v1/projects" \
 -d '{
  "organizationId" : "organizationId",
  "name" : "name",
  "description" : "description"
}'
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        CreateProjectRequest createProjectRequest = ; // CreateProjectRequest | 

        try {
            Project result = apiInstance.createProject(createProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#createProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateProjectRequest createProjectRequest = new CreateProjectRequest(); // CreateProjectRequest | 

try {
    final result = await api_instance.createProject(createProjectRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProject: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        CreateProjectRequest createProjectRequest = ; // CreateProjectRequest | 

        try {
            Project result = apiInstance.createProject(createProjectRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#createProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
CreateProjectRequest *createProjectRequest = ; // 

// Create a project
[apiInstance createProjectWith:createProjectRequest
              completionHandler: ^(Project output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var createProjectRequest = ; // {CreateProjectRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var createProjectRequest = new CreateProjectRequest(); // CreateProjectRequest | 

            try {
                // Create a project
                Project result = apiInstance.createProject(createProjectRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$createProjectRequest = ; // CreateProjectRequest | 

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $createProjectRequest = WWW::OPenAPIClient::Object::CreateProjectRequest->new(); # CreateProjectRequest | 

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

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
createProjectRequest =  # CreateProjectRequest | 

try:
    # Create a project
    api_response = api_instance.create_project(createProjectRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->createProject: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let createProjectRequest = ; // CreateProjectRequest

    let mut context = ProjectsApi::Context::default();
    let result = client.createProject(createProjectRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
createProjectRequest *

The set of properties to be associated with the new project

Responses


getProject

Find details on a project

Returns the details on single project's record


/projects/{projectId}

Usage and SDK Samples

curl -X GET \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}"
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve

        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to retrieve

try {
    final result = await api_instance.getProject(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProject: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve

        try {
            Project result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to retrieve (default to null)

// Find details on a project
[apiInstance getProjectWith:projectId
              completionHandler: ^(Project output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to retrieve

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to retrieve (default to null)

            try {
                // Find details on a project
                Project result = apiInstance.getProject(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.getProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to retrieve

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to retrieve

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

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to retrieve (default to null)

try:
    # Find details on a project
    api_response = api_instance.get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProject: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectsApi::Context::default();
    let result = client.getProject(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to retrieve
Required

Responses


getProjectItems

Retrieve all items in project

Returns the details on all items within a project


/projects/{projectId}/items

Usage and SDK Samples

curl -X GET \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}/items"
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve items from

        try {
            array[ProjectItem] result = apiInstance.getProjectItems(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectItems");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to retrieve items from

try {
    final result = await api_instance.getProjectItems(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProjectItems: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve items from

        try {
            array[ProjectItem] result = apiInstance.getProjectItems(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectItems");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to retrieve items from (default to null)

// Retrieve all items in project
[apiInstance getProjectItemsWith:projectId
              completionHandler: ^(array[ProjectItem] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to retrieve items from

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to retrieve items from (default to null)

            try {
                // Retrieve all items in project
                array[ProjectItem] result = apiInstance.getProjectItems(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.getProjectItems: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to retrieve items from

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to retrieve items from

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

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to retrieve items from (default to null)

try:
    # Retrieve all items in project
    api_response = api_instance.get_project_items(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjectItems: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectsApi::Context::default();
    let result = client.getProjectItems(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to retrieve items from
Required

Responses


getProjectItemsOfType

Retrieve items of type in project

Returns the details on all items within a project of a given type


/projects/{projectId}/itemsOfType/{itemType}

Usage and SDK Samples

curl -X GET \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}/itemsOfType/{itemType}"
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve items from
        String itemType = itemType_example; // String | The type of item to retrieve

        try {
            array[ProjectItem] result = apiInstance.getProjectItemsOfType(projectId, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectItemsOfType");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to retrieve items from
final String itemType = new String(); // String | The type of item to retrieve

try {
    final result = await api_instance.getProjectItemsOfType(projectId, itemType);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getProjectItemsOfType: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to retrieve items from
        String itemType = itemType_example; // String | The type of item to retrieve

        try {
            array[ProjectItem] result = apiInstance.getProjectItemsOfType(projectId, itemType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProjectItemsOfType");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to retrieve items from (default to null)
String *itemType = itemType_example; // The type of item to retrieve (default to null)

// Retrieve items of type in project
[apiInstance getProjectItemsOfTypeWith:projectId
    itemType:itemType
              completionHandler: ^(array[ProjectItem] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to retrieve items from
var itemType = itemType_example; // {String} The type of item to retrieve

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to retrieve items from (default to null)
            var itemType = itemType_example;  // String | The type of item to retrieve (default to null)

            try {
                // Retrieve items of type in project
                array[ProjectItem] result = apiInstance.getProjectItemsOfType(projectId, itemType);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.getProjectItemsOfType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to retrieve items from
$itemType = itemType_example; // String | The type of item to retrieve

try {
    $result = $api_instance->getProjectItemsOfType($projectId, $itemType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->getProjectItemsOfType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to retrieve items from
my $itemType = itemType_example; # String | The type of item to retrieve

eval {
    my $result = $api_instance->getProjectItemsOfType(projectId => $projectId, itemType => $itemType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProjectItemsOfType: $@\n";
}
from __future__ import print_statement
import time
import curio_genomics_client
from curio_genomics_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to retrieve items from (default to null)
itemType = itemType_example # String | The type of item to retrieve (default to null)

try:
    # Retrieve items of type in project
    api_response = api_instance.get_project_items_of_type(projectId, itemType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProjectItemsOfType: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let itemType = itemType_example; // String

    let mut context = ProjectsApi::Context::default();
    let result = client.getProjectItemsOfType(projectId, itemType, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to retrieve items from
Required
itemType*
String
The type of item to retrieve
Required

Responses


importFromUrl

Import a file into project from a URL

Start an import of a file into a project from an HTTP/HTTPS end point


/projects/{projectId}/importFromUrl

Usage and SDK Samples

curl -X POST \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}/importFromUrl" \
 -d '{
  "name" : "name",
  "url" : "url"
}'
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to import data into
        ImportFromUrlRequest importFromUrlRequest = ; // ImportFromUrlRequest | 

        try {
            ProjectItem result = apiInstance.importFromUrl(projectId, importFromUrlRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#importFromUrl");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to import data into
final ImportFromUrlRequest importFromUrlRequest = new ImportFromUrlRequest(); // ImportFromUrlRequest | 

try {
    final result = await api_instance.importFromUrl(projectId, importFromUrlRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importFromUrl: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to import data into
        ImportFromUrlRequest importFromUrlRequest = ; // ImportFromUrlRequest | 

        try {
            ProjectItem result = apiInstance.importFromUrl(projectId, importFromUrlRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#importFromUrl");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to import data into (default to null)
ImportFromUrlRequest *importFromUrlRequest = ; // 

// Import a file into project from a URL
[apiInstance importFromUrlWith:projectId
    importFromUrlRequest:importFromUrlRequest
              completionHandler: ^(ProjectItem output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to import data into
var importFromUrlRequest = ; // {ImportFromUrlRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to import data into (default to null)
            var importFromUrlRequest = new ImportFromUrlRequest(); // ImportFromUrlRequest | 

            try {
                // Import a file into project from a URL
                ProjectItem result = apiInstance.importFromUrl(projectId, importFromUrlRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.importFromUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to import data into
$importFromUrlRequest = ; // ImportFromUrlRequest | 

try {
    $result = $api_instance->importFromUrl($projectId, $importFromUrlRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->importFromUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to import data into
my $importFromUrlRequest = WWW::OPenAPIClient::Object::ImportFromUrlRequest->new(); # ImportFromUrlRequest | 

eval {
    my $result = $api_instance->importFromUrl(projectId => $projectId, importFromUrlRequest => $importFromUrlRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->importFromUrl: $@\n";
}
from __future__ import print_statement
import time
import curio_genomics_client
from curio_genomics_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to import data into (default to null)
importFromUrlRequest =  # ImportFromUrlRequest | 

try:
    # Import a file into project from a URL
    api_response = api_instance.import_from_url(projectId, importFromUrlRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->importFromUrl: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let importFromUrlRequest = ; // ImportFromUrlRequest

    let mut context = ProjectsApi::Context::default();
    let result = client.importFromUrl(projectId, importFromUrlRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to import data into
Required
Body parameters
Name Description
importFromUrlRequest *

The set of properties that defines the file to import

Responses


startAnalyses

Start multiple project analyses

Start multiple analyses within a project


/projects/{projectId}/startAnalyses

Usage and SDK Samples

curl -X POST \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}/startAnalyses" \
 -d '{
  "jobTemplateProjectItemKey" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
  "analyisInputs" : [ {
    "inputProjectItemKeyB" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
    "inputProjectItemKeyA" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10"
  }, {
    "inputProjectItemKeyB" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
    "inputProjectItemKeyA" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10"
  } ],
  "sendEmailWhenComplete" : false
}'
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to start the analyses within
        StartAnalysesRequest startAnalysesRequest = ; // StartAnalysesRequest | 

        try {
            StartAnalysesResponse result = apiInstance.startAnalyses(projectId, startAnalysesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#startAnalyses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to start the analyses within
final StartAnalysesRequest startAnalysesRequest = new StartAnalysesRequest(); // StartAnalysesRequest | 

try {
    final result = await api_instance.startAnalyses(projectId, startAnalysesRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startAnalyses: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to start the analyses within
        StartAnalysesRequest startAnalysesRequest = ; // StartAnalysesRequest | 

        try {
            StartAnalysesResponse result = apiInstance.startAnalyses(projectId, startAnalysesRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#startAnalyses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to start the analyses within (default to null)
StartAnalysesRequest *startAnalysesRequest = ; // 

// Start multiple project analyses
[apiInstance startAnalysesWith:projectId
    startAnalysesRequest:startAnalysesRequest
              completionHandler: ^(StartAnalysesResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to start the analyses within
var startAnalysesRequest = ; // {StartAnalysesRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to start the analyses within (default to null)
            var startAnalysesRequest = new StartAnalysesRequest(); // StartAnalysesRequest | 

            try {
                // Start multiple project analyses
                StartAnalysesResponse result = apiInstance.startAnalyses(projectId, startAnalysesRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.startAnalyses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to start the analyses within
$startAnalysesRequest = ; // StartAnalysesRequest | 

try {
    $result = $api_instance->startAnalyses($projectId, $startAnalysesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->startAnalyses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to start the analyses within
my $startAnalysesRequest = WWW::OPenAPIClient::Object::StartAnalysesRequest->new(); # StartAnalysesRequest | 

eval {
    my $result = $api_instance->startAnalyses(projectId => $projectId, startAnalysesRequest => $startAnalysesRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->startAnalyses: $@\n";
}
from __future__ import print_statement
import time
import curio_genomics_client
from curio_genomics_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to start the analyses within (default to null)
startAnalysesRequest =  # StartAnalysesRequest | 

try:
    # Start multiple project analyses
    api_response = api_instance.start_analyses(projectId, startAnalysesRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->startAnalyses: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let startAnalysesRequest = ; // StartAnalysesRequest

    let mut context = ProjectsApi::Context::default();
    let result = client.startAnalyses(projectId, startAnalysesRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to start the analyses within
Required
Body parameters
Name Description
startAnalysesRequest *

The set of properties that defines all of the analyses to start

Responses


startAnalysis

Start a single project analysis

Start a single analysis within a project


/projects/{projectId}/startAnalysis

Usage and SDK Samples

curl -X POST \
-H "API-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://api.curiogenomics.com/v1/projects/{projectId}/startAnalysis" \
 -d '{
  "inputProjectItemKeyB" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
  "inputProjectItemKeyA" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
  "jobTemplateProjectItemKey" : "wqzJ77i2MHnzlJAyFxy4/byKJdkkQk0tdSmc1vO10",
  "sendEmailWhenComplete" : false
}'
import com.curiogenomics.client.*;
import com.curiogenomics.client.auth.*;
import com.curiogenomics.client.model.*;
import com.curiogenomics.client.api.ProjectsApi;

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

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

        // Configure API key authorization: API-Key
        ApiKeyAuth API-Key = (ApiKeyAuth) defaultClient.getAuthentication("API-Key");
        API-Key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //API-Key.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to start the analysis within
        StartAnalysisRequest startAnalysisRequest = ; // StartAnalysisRequest | 

        try {
            StartAnalysisResponse result = apiInstance.startAnalysis(projectId, startAnalysisRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#startAnalysis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The unique identifier of the project to start the analysis within
final StartAnalysisRequest startAnalysisRequest = new StartAnalysisRequest(); // StartAnalysisRequest | 

try {
    final result = await api_instance.startAnalysis(projectId, startAnalysisRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startAnalysis: $e\n');
}

import com.curiogenomics.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        String projectId = projectId_example; // String | The unique identifier of the project to start the analysis within
        StartAnalysisRequest startAnalysisRequest = ; // StartAnalysisRequest | 

        try {
            StartAnalysisResponse result = apiInstance.startAnalysis(projectId, startAnalysisRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#startAnalysis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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


// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
String *projectId = projectId_example; // The unique identifier of the project to start the analysis within (default to null)
StartAnalysisRequest *startAnalysisRequest = ; // 

// Start a single project analysis
[apiInstance startAnalysisWith:projectId
    startAnalysisRequest:startAnalysisRequest
              completionHandler: ^(StartAnalysisResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var CurioGenomicsServicesApi = require('curio_genomics_services_api');
var defaultClient = CurioGenomicsServicesApi.ApiClient.instance;

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

// Create an instance of the API class
var api = new CurioGenomicsServicesApi.ProjectsApi()
var projectId = projectId_example; // {String} The unique identifier of the project to start the analysis within
var startAnalysisRequest = ; // {StartAnalysisRequest} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = projectId_example;  // String | The unique identifier of the project to start the analysis within (default to null)
            var startAnalysisRequest = new StartAnalysisRequest(); // StartAnalysisRequest | 

            try {
                // Start a single project analysis
                StartAnalysisResponse result = apiInstance.startAnalysis(projectId, startAnalysisRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.startAnalysis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = projectId_example; // String | The unique identifier of the project to start the analysis within
$startAnalysisRequest = ; // StartAnalysisRequest | 

try {
    $result = $api_instance->startAnalysis($projectId, $startAnalysisRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->startAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = projectId_example; # String | The unique identifier of the project to start the analysis within
my $startAnalysisRequest = WWW::OPenAPIClient::Object::StartAnalysisRequest->new(); # StartAnalysisRequest | 

eval {
    my $result = $api_instance->startAnalysis(projectId => $projectId, startAnalysisRequest => $startAnalysisRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->startAnalysis: $@\n";
}
from __future__ import print_statement
import time
import curio_genomics_client
from curio_genomics_client.rest import ApiException
from pprint import pprint

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

# Create an instance of the API class
api_instance = curio_genomics_client.ProjectsApi()
projectId = projectId_example # String | The unique identifier of the project to start the analysis within (default to null)
startAnalysisRequest =  # StartAnalysisRequest | 

try:
    # Start a single project analysis
    api_response = api_instance.start_analysis(projectId, startAnalysisRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->startAnalysis: %s\n" % e)
extern crate ProjectsApi;

pub fn main() {
    let projectId = projectId_example; // String
    let startAnalysisRequest = ; // StartAnalysisRequest

    let mut context = ProjectsApi::Context::default();
    let result = client.startAnalysis(projectId, startAnalysisRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The unique identifier of the project to start the analysis within
Required
Body parameters
Name Description
startAnalysisRequest *

The set of properties that defines the analysis to start

Responses