libica.openapi.v2.SampleApi

All URIs are relative to /ica/rest

Method	HTTP request	Description
get_samples	GET /api/samples	Retrieve a list of samples.

get_samples

SamplePagedList get_samples(region)

Retrieve a list of samples.

Example

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import sample_api
from libica.openapi.v2.model.sample_paged_list import SamplePagedList
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 = sample_api.SampleApi(api_client)
    region = "region_example" # str | The ID of the region to filter on. This parameter is required.
    search = "search_example" # str | To search through multiple fields of data. (optional)
    user_tags = "userTags_example" # str | The user tags to filter on. (optional)
    technical_tags = "technicalTags_example" # str | The technical tags to filter on. (optional)
    page_offset = "pageOffset_example" # str | [only use with offset-based paging]<br>The amount of rows to skip in the result. Ideally this is a multiple of the size parameter. Offset-based pagination has a result limit of 200K rows and does not guarantee unique results across pages (optional)
    page_token = "pageToken_example" # str | [only use with cursor-based paging]<br>The cursor to get subsequent results. The value to use is returned in the result when using cursor-based pagination. Cursor-based pagination guarantees complete and unique results across all pages. (optional)
    page_size = "pageSize_example" # str | [can be used with both offset- and cursor-based paging]<br>The amount of rows to return. Use in combination with the offset (when using offset-based pagination) or cursor (when using cursor-based pagination) parameter to get subsequent results (optional)
    sort = "sort_example" # str | [only use with offset-based paging]<br>Which field to order the results by. The default order is ascending, suffix with ' desc' to sort descending (suffix ' asc' also works for ascending). Multiple values should be separated with commas. An example: \"?sort=sortAttribute1, sortAttribute2 desc\"  The attributes for which sorting is supported: - timeCreated - timeModified - name - description - metadataValid - status (optional)

    # example passing only required values which don't have defaults set
    try:
        # Retrieve a list of samples.
        api_response = api_instance.get_samples(region)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling SampleApi->get_samples: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Retrieve a list of samples.
        api_response = api_instance.get_samples(region, search=search, user_tags=user_tags, technical_tags=technical_tags, page_offset=page_offset, page_token=page_token, page_size=page_size, sort=sort)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling SampleApi->get_samples: %s\n" % e)

Parameters

Name	Type	Description	Notes
region	str	The ID of the region to filter on. This parameter is required.
search	str	To search through multiple fields of data.	[optional]
user_tags	str	The user tags to filter on.	[optional]
technical_tags	str	The technical tags to filter on.	[optional]
page_offset	str	[only use with offset-based paging]<br>The amount of rows to skip in the result. Ideally this is a multiple of the size parameter. Offset-based pagination has a result limit of 200K rows and does not guarantee unique results across pages	[optional]
page_token	str	[only use with cursor-based paging]<br>The cursor to get subsequent results. The value to use is returned in the result when using cursor-based pagination. Cursor-based pagination guarantees complete and unique results across all pages.	[optional]
page_size	str	[can be used with both offset- and cursor-based paging]<br>The amount of rows to return. Use in combination with the offset (when using offset-based pagination) or cursor (when using cursor-based pagination) parameter to get subsequent results	[optional]
sort	str	[only use with offset-based paging]<br>Which field to order the results by. The default order is ascending, suffix with ' desc' to sort descending (suffix ' asc' also works for ascending). Multiple values should be separated with commas. An example: \"?sort=sortAttribute1, sortAttribute2 desc\" The attributes for which sorting is supported: - timeCreated - timeModified - name - description - metadataValid - status	[optional]

Return type

SamplePagedList

Authorization

ApiKeyAuth, JwtAuth

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 samples is successfully retrieved.	-
0	A problem occurred.	-

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