libica.openapi.v3.ReferenceSetApi

All URIs are relative to /ica/rest

Method	HTTP request	Description
get_reference_sets	GET /api/referenceSets	Retrieve a list of of reference sets.
get_species	GET /api/referenceSets/{referenceSetId}/species	Retrieve a list of species linked to the reference set.

get_reference_sets

ReferenceSetList get_reference_sets()

Retrieve a list of of reference sets.

Example

• Bearer (JWT) Authentication (JwtAuth):
• Api Key Authentication (ApiKeyAuth):

import libica.openapi.v3
from libica.openapi.v3.models.reference_set_list import ReferenceSetList
from libica.openapi.v3.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /ica/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.v3.Configuration(
    host = "/ica/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v3.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.v3.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.v3.ReferenceSetApi(api_client)

    try:
        # Retrieve a list of of reference sets.
        api_response = api_instance.get_reference_sets()
        print("The response of ReferenceSetApi->get_reference_sets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReferenceSetApi->get_reference_sets: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ReferenceSetList

Authorization

JwtAuth, ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json, application/vnd.illumina.v3+json

HTTP response details

Status code	Description	Response headers
200	The list of reference sets is successfully retrieved.	-
0	A problem occurred.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_species

SpeciesList get_species(reference_set_id)

Retrieve a list of species linked to the reference set.

Example

• Bearer (JWT) Authentication (JwtAuth):
• Api Key Authentication (ApiKeyAuth):

import libica.openapi.v3
from libica.openapi.v3.models.species_list import SpeciesList
from libica.openapi.v3.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /ica/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.v3.Configuration(
    host = "/ica/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v3.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.v3.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.v3.ReferenceSetApi(api_client)
    reference_set_id = 'reference_set_id_example' # str | 

    try:
        # Retrieve a list of species linked to the reference set.
        api_response = api_instance.get_species(reference_set_id)
        print("The response of ReferenceSetApi->get_species:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReferenceSetApi->get_species: %s\n" % e)

Parameters

Name	Type	Description	Notes
reference_set_id	str

Return type

SpeciesList

Authorization

JwtAuth, ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/problem+json, application/vnd.illumina.v3+json

HTTP response details

Status code	Description	Response headers
200	The list of species is successfully retrieved.	-
0	A problem occurred.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]