libica.openapi.v3.BundlePipelineApi¶

All URIs are relative to /ica/rest

Method	HTTP request	Description
get_bundle_pipelines	GET /api/bundles/{bundleId}/pipelines	Retrieve a list of bundle pipelines.
link_pipeline_to_bundle	POST /api/bundles/{bundleId}/pipelines/{pipelineId}	Link a pipeline to a bundle.
unlink_pipeline_from_bundle	DELETE /api/bundles/{bundleId}/pipelines/{pipelineId}	Unlink a pipeline from a bundle.

get_bundle_pipelines¶

BundlePipelineList get_bundle_pipelines(bundle_id)

Retrieve a list of bundle pipelines.

Example¶

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

import libica.openapi.v3
from libica.openapi.v3.models.bundle_pipeline_list import BundlePipelineList
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.BundlePipelineApi(api_client)
    bundle_id = 'bundle_id_example' # str | The ID of the bundle to retrieve pipelines for

    try:
        # Retrieve a list of bundle pipelines.
        api_response = api_instance.get_bundle_pipelines(bundle_id)
        print("The response of BundlePipelineApi->get_bundle_pipelines:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BundlePipelineApi->get_bundle_pipelines: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
bundle_id	str	The ID of the bundle to retrieve pipelines for

Return type¶

BundlePipelineList

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

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

link_pipeline_to_bundle¶

link_pipeline_to_bundle(bundle_id, pipeline_id)

Link a pipeline to a bundle.

Example¶

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

import libica.openapi.v3
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.BundlePipelineApi(api_client)
    bundle_id = 'bundle_id_example' # str | The ID of the bundle
    pipeline_id = 'pipeline_id_example' # str | The ID of the pipeline

    try:
        # Link a pipeline to a bundle.
        api_instance.link_pipeline_to_bundle(bundle_id, pipeline_id)
    except Exception as e:
        print("Exception when calling BundlePipelineApi->link_pipeline_to_bundle: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
bundle_id	str	The ID of the bundle
pipeline_id	str	The ID of the pipeline

Return type¶

void (empty response body)

Authorization¶

JwtAuth, ApiKeyAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/problem+json

HTTP response details¶

Status code	Description	Response headers
204	The pipeline is successfully linked to the bundle.	-
0	A problem occurred.	-

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

unlink_pipeline_from_bundle¶

unlink_pipeline_from_bundle(bundle_id, pipeline_id)

Unlink a pipeline from a bundle.

Example¶

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

import libica.openapi.v3
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.BundlePipelineApi(api_client)
    bundle_id = 'bundle_id_example' # str | The ID of the bundle
    pipeline_id = 'pipeline_id_example' # str | The ID of the pipeline

    try:
        # Unlink a pipeline from a bundle.
        api_instance.unlink_pipeline_from_bundle(bundle_id, pipeline_id)
    except Exception as e:
        print("Exception when calling BundlePipelineApi->unlink_pipeline_from_bundle: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
bundle_id	str	The ID of the bundle
pipeline_id	str	The ID of the pipeline

Return type¶

void (empty response body)

Authorization¶

JwtAuth, ApiKeyAuth

HTTP request headers¶

Content-Type: Not defined
Accept: application/problem+json

HTTP response details¶

Status code	Description	Response headers
204	The pipeline is successfully unlinked from the bundle.	-
0	A problem occurred.	-

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