libica.openapi.v3.NotificationChannelApi¶

All URIs are relative to /ica/rest

Method	HTTP request	Description
create_notification_channel	POST /api/notificationChannels	Create a notification channel
delete_notification_channel	DELETE /api/notificationChannels/{channelId}	Delete a notification channel
get_notification_channel	GET /api/notificationChannels/{channelId}	Retrieve a notification channel
get_notification_channels	GET /api/notificationChannels	Retrieve notification channels
update_notification_channel	PUT /api/notificationChannels/{channelId}	Update a notification channel

create_notification_channel¶

NotificationChannel create_notification_channel(create_notification_channel)

Create a notification channel

Example¶

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

import libica.openapi.v3
from libica.openapi.v3.models.create_notification_channel import CreateNotificationChannel
from libica.openapi.v3.models.notification_channel import NotificationChannel
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.NotificationChannelApi(api_client)
    create_notification_channel = libica.openapi.v3.CreateNotificationChannel() # CreateNotificationChannel | The new channel

    try:
        # Create a notification channel
        api_response = api_instance.create_notification_channel(create_notification_channel)
        print("The response of NotificationChannelApi->create_notification_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationChannelApi->create_notification_channel: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
create_notification_channel	CreateNotificationChannel	The new channel

Return type¶

NotificationChannel

Authorization¶

JwtAuth, ApiKeyAuth

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	The notification channel is successfully created.	* 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]

delete_notification_channel¶

delete_notification_channel(channel_id)

Delete a notification channel

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.NotificationChannelApi(api_client)
    channel_id = 'channel_id_example' # str | The ID of the notification channel to delete

    try:
        # Delete a notification channel
        api_instance.delete_notification_channel(channel_id)
    except Exception as e:
        print("Exception when calling NotificationChannelApi->delete_notification_channel: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
channel_id	str	The ID of the notification channel to delete

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 notification channel is successfully deleted	-
0	A problem occurred.	-

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

get_notification_channel¶

NotificationChannel get_notification_channel(channel_id)

Retrieve a notification channel

Example¶

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

import libica.openapi.v3
from libica.openapi.v3.models.notification_channel import NotificationChannel
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.NotificationChannelApi(api_client)
    channel_id = 'channel_id_example' # str | The ID of the notification channel to retrieve

    try:
        # Retrieve a notification channel
        api_response = api_instance.get_notification_channel(channel_id)
        print("The response of NotificationChannelApi->get_notification_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationChannelApi->get_notification_channel: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
channel_id	str	The ID of the notification channel to retrieve

Return type¶

NotificationChannel

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 notification channel 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_notification_channels¶

NotificationChannelList get_notification_channels()

Retrieve notification channels

Example¶

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

import libica.openapi.v3
from libica.openapi.v3.models.notification_channel_list import NotificationChannelList
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.NotificationChannelApi(api_client)

    try:
        # Retrieve notification channels
        api_response = api_instance.get_notification_channels()
        print("The response of NotificationChannelApi->get_notification_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationChannelApi->get_notification_channels: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

NotificationChannelList

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 notification channels are successfully retrieved.	-
0	A problem occurred.	-

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

update_notification_channel¶

NotificationChannel update_notification_channel(channel_id, notification_channel, if_match=if_match)

Update a notification channel

This will affect all subscriptions which use this address!Fields which can be updated: - enabled - address - awsRegion

Example¶

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

import libica.openapi.v3
from libica.openapi.v3.models.notification_channel import NotificationChannel
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.NotificationChannelApi(api_client)
    channel_id = 'channel_id_example' # str | The ID of the notification channel to update
    notification_channel = libica.openapi.v3.NotificationChannel() # NotificationChannel | The updated channel
    if_match = 'if_match_example' # str | Optional header parameter to enable conflict exposure. If the client provides this header, then it must contains the client's most recent value of the 'ETag' response header, and the server will respond with a 409 code if it detects a conflict. If the client does not provide this header, then the server will not do a conflict check, which means that as a client you can override the resource even when the server has a more recent version. (optional)

    try:
        # Update a notification channel
        api_response = api_instance.update_notification_channel(channel_id, notification_channel, if_match=if_match)
        print("The response of NotificationChannelApi->update_notification_channel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationChannelApi->update_notification_channel: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
channel_id	str	The ID of the notification channel to update
notification_channel	NotificationChannel	The updated channel
if_match	str	Optional header parameter to enable conflict exposure. If the client provides this header, then it must contains the client's most recent value of the 'ETag' response header, and the server will respond with a 409 code if it detects a conflict. If the client does not provide this header, then the server will not do a conflict check, which means that as a client you can override the resource even when the server has a more recent version.	[optional]

Return type¶

NotificationChannel

Authorization¶

JwtAuth, ApiKeyAuth

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
200	The notification channel is successfully updated.	* 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]