libica.openapi.v2.RegionApi¶

All URIs are relative to /ica/rest

Method	HTTP request	Description
get_region	GET /api/regions/{regionId}	Retrieve a region. Only the regions the user has access to through his/her entitlements can be retrieved.
get_regions	GET /api/regions	Retrieve a list of regions. Only the regions the user has access to through his/her entitlements are returned.

get_region¶

Region get_region(region_id)

Retrieve a region. Only the regions the user has access to through his/her entitlements can be retrieved.

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import region_api
from libica.openapi.v2.model.region import Region
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 = region_api.RegionApi(api_client)
    region_id = "regionId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Retrieve a region. Only the regions the user has access to through his/her entitlements can be retrieved.
        api_response = api_instance.get_region(region_id)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling RegionApi->get_region: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
region_id	str

Return type¶

Region

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

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

get_regions¶

RegionList get_regions()

Retrieve a list of regions. Only the regions the user has access to through his/her entitlements are returned.