Skip to content

libica.openapi.v2.ProjectAnalysisStorageApi

All URIs are relative to /ica/rest

Method HTTP request Description
get_project_analysis_storage_options GET /api/projects/{projectId}/analysisStorages Retrieve the list of project analysis storage options.

get_project_analysis_storage_options

AnalysisStorageListV4 get_project_analysis_storage_options(project_id)

Retrieve the list of project analysis storage options.

Example

  • Api Key Authentication (ApiKeyAuth):
  • Bearer (JWT) Authentication (JwtAuth):
import time
import libica.openapi.v2
from libica.openapi.v2.api import project_analysis_storage_api
from libica.openapi.v2.model.analysis_storage_list_v4 import AnalysisStorageListV4
from libica.openapi.v2.model.problem import Problem
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.v2.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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): JwtAuth
configuration = libica.openapi.v2.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with libica.openapi.v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = project_analysis_storage_api.ProjectAnalysisStorageApi(api_client)
    project_id = "projectId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Retrieve the list of project analysis storage options.
        api_response = api_instance.get_project_analysis_storage_options(project_id)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling ProjectAnalysisStorageApi->get_project_analysis_storage_options: %s\n" % e)

Parameters

Name Type Description Notes
project_id str

Return type

AnalysisStorageListV4

Authorization

ApiKeyAuth, JwtAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The list of project analysis storage options is successfully retrieved. -
0 A problem occurred. -

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