libica.openapi.v2.ProjectBaseApi¶

All URIs are relative to /ica/rest

Method	HTTP request	Description
create_base_connection_details	POST /api/projects/{projectId}/base:connectionDetails	Creates the connection details to snowflake instance.
get_base_job	GET /api/projects/{projectId}/base/jobs/{baseJobId}	Retrieve a base job.
get_base_jobs	GET /api/projects/{projectId}/base/jobs	Retrieve a list of base jobs
get_base_tables	GET /api/projects/{projectId}/base/tables	Retrieve a list of base tables.
load_data	POST /api/projects/{projectId}/base/tables/{tableId}:loadData	Load data in a base table.

create_base_connection_details¶

BaseConnection create_base_connection_details(project_id)

Creates the connection details to snowflake instance.

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import project_base_api
from libica.openapi.v2.model.problem import Problem
from libica.openapi.v2.model.base_connection import BaseConnection
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_base_api.ProjectBaseApi(api_client)
    project_id = "projectId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Creates the connection details to snowflake instance.
        api_response = api_instance.create_base_connection_details(project_id)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling ProjectBaseApi->create_base_connection_details: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
project_id	str

Return type¶

BaseConnection

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 base connection details are created.	-
0	A problem occurred.	-

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

get_base_job¶

BaseJob get_base_job(project_id, base_job_id)

Retrieve a base job.

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import project_base_api
from libica.openapi.v2.model.base_job import BaseJob
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_base_api.ProjectBaseApi(api_client)
    project_id = "projectId_example" # str | 
    base_job_id = "baseJobId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Retrieve a base job.
        api_response = api_instance.get_base_job(project_id, base_job_id)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling ProjectBaseApi->get_base_job: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
project_id	str
base_job_id	str

Return type¶

BaseJob

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 base job is successfully retrieved.	* ETag - The current version of the resource. Can be passed to the corresponding PUT endpoint to enable conflict exposure (409 response).
0	A problem occurred.	-

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

get_base_jobs¶

BaseJobList get_base_jobs(project_id)

Retrieve a list of base jobs

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import project_base_api
from libica.openapi.v2.model.base_job_list import BaseJobList
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_base_api.ProjectBaseApi(api_client)
    project_id = "projectId_example" # str | 
    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: - description - type (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Retrieve a list of base jobs
        api_response = api_instance.get_base_jobs(project_id, 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 ProjectBaseApi->get_base_jobs: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
project_id	str
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: - description - type	[optional]

Return type¶

BaseJobList

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

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

get_base_tables¶

ProjectBaseTableList get_base_tables(project_id)

Retrieve a list of base tables.

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import project_base_api
from libica.openapi.v2.model.project_base_table_list import ProjectBaseTableList
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_base_api.ProjectBaseApi(api_client)
    project_id = "projectId_example" # str | 

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

Parameters¶

Name	Type	Description	Notes
project_id	str

Return type¶

ProjectBaseTableList

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

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

load_data¶

BaseJob load_data(project_id, table_id, load_data_in_base_request)

Load data in a base table.

Load data in the specified table

Example¶

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

import time
import libica.openapi.v2
from libica.openapi.v2.api import project_base_api
from libica.openapi.v2.model.base_job import BaseJob
from libica.openapi.v2.model.load_data_in_base_request import LoadDataInBaseRequest
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_base_api.ProjectBaseApi(api_client)
    project_id = "projectId_example" # str | 
    table_id = "tableId_example" # str | 
    load_data_in_base_request = LoadDataInBaseRequest(
        allow_quoted_newlines=False,
        data_id="data_id_example",
        delimiter=",",
        encoding="UTF8",
        force_load=False,
        header_rows_to_skip=1,
        ignore_unknown_values=False,
        include_references=True,
        include_data_reference=True,
        include_sample_reference=True,
        include_pipeline_reference=True,
        include_pipeline_execution_reference=True,
        include_tenant_reference=True,
        null_marker="null_marker_example",
        number_of_errors_allowed=0,
        quote="quote_example",
        write_preference="APPENDTOTABLE",
    ) # LoadDataInBaseRequest | Load data request

    # example passing only required values which don't have defaults set
    try:
        # Load data in a base table.
        api_response = api_instance.load_data(project_id, table_id, load_data_in_base_request)
        pprint(api_response)
    except libica.openapi.v2.ApiException as e:
        print("Exception when calling ProjectBaseApi->load_data: %s\n" % e)

Parameters¶

Name	Type	Description
project_id	str
table_id	str
load_data_in_base_request	LoadDataInBaseRequest	Load data request

Return type¶

BaseJob

Authorization¶

ApiKeyAuth, JwtAuth

HTTP request headers¶

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

HTTP response details¶

Status code	Description	Response headers
201	Base job to load data is created.	-
0	A problem occurred.	-

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