ibm_gdsc_sdk_saas.NotificationsServiceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
notifications_service_create_ticket	POST /api/v3/integrations/ticket	Summary: Create ticket Description: Create ticket based on information passed in.
notifications_service_get_folders	POST /api/v3/integrations/folders	Summary: Get folders Description: Get folder for the integration connection provided.
notifications_service_get_notification_filename	GET /api/v3/notifications/filename	Summary: Get notification filename Description: Return filename associated with the notifications record referenced in the associated context record. The notification id is required but may be set in the associated authentication token or explicitly in the request.
notifications_service_get_notification_record	GET /api/v3/notifications/details/{notification_id}	Summary: Get notification record Description: Return notifications record with the specified ID.
notifications_service_get_notification_records	GET /api/v3/notifications	Summary: Get notification records Description: Return notifications records that match the specified filter.
notifications_service_get_ticket_status	GET /api/v3/integrations/ticket/status	Summary: Get ticket status Description: Get the status of the given ticket
notifications_service_post_notification_record	POST /api/v3/notifications	Summary: For PostNotificationRecord notification only Description: Sends notification with recipients and returns a status
notifications_service_search_notification_records	POST /api/v3/notifications/search	Summary: Search notification records Description: Return notification records using pipeline of filters
notifications_service_test_integration	POST /api/v3/integrations/test	Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible a test message is sent to the integration to ensure it is functional.
notifications_service_update_notification_record	PUT /api/v3/notifications	Summary: Update notification record Description: Update a notification record with the specified values. The ID field is required and must match an existing notification. All fields other than the ID are optional. Creation timestamp, user and other administrative fields can not updated.

notifications_service_create_ticket

Notificationsv3CreateTicketResponse notifications_service_create_ticket(notificationsv3_create_ticket_request)

Summary: Create ticket Description: Create ticket based on information passed in.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_create_ticket_request import Notificationsv3CreateTicketRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_create_ticket_response import Notificationsv3CreateTicketResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_create_ticket_request = ibm_gdsc_sdk_saas.Notificationsv3CreateTicketRequest() # Notificationsv3CreateTicketRequest | 

    try:
        # Summary: Create ticket Description: Create ticket based on information passed in.
        api_response = api_instance.notifications_service_create_ticket(notificationsv3_create_ticket_request)
        print("The response of NotificationsServiceApi->notifications_service_create_ticket:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_create_ticket: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_create_ticket_request	Notificationsv3CreateTicketRequest

Return type

Notificationsv3CreateTicketResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_get_folders

Notificationsv3GetFoldersResponse notifications_service_get_folders(notificationsv3_get_folders_request)

Summary: Get folders Description: Get folder for the integration connection provided.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_get_folders_request import Notificationsv3GetFoldersRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_get_folders_response import Notificationsv3GetFoldersResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_get_folders_request = ibm_gdsc_sdk_saas.Notificationsv3GetFoldersRequest() # Notificationsv3GetFoldersRequest | 

    try:
        # Summary: Get folders Description: Get folder for the integration connection provided.
        api_response = api_instance.notifications_service_get_folders(notificationsv3_get_folders_request)
        print("The response of NotificationsServiceApi->notifications_service_get_folders:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_get_folders: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_get_folders_request	Notificationsv3GetFoldersRequest

Return type

Notificationsv3GetFoldersResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_get_notification_filename

Notificationsv3GetNotificationFilenameResponse notifications_service_get_notification_filename(notification_id=notification_id)

Summary: Get notification filename Description: Return filename associated with the notifications record referenced in the associated context record. The notification id is required but may be set in the associated authentication token or explicitly in the request.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_get_notification_filename_response import Notificationsv3GetNotificationFilenameResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notification_id = 'notification_id_example' # str | Params are located in the requests context (tenant id, user email, notification id). (optional)

    try:
        # Summary: Get notification filename Description: Return filename associated with the notifications record referenced in the associated context record. The notification id is required but may be set in the associated authentication token or explicitly in the request.
        api_response = api_instance.notifications_service_get_notification_filename(notification_id=notification_id)
        print("The response of NotificationsServiceApi->notifications_service_get_notification_filename:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_get_notification_filename: %s\n" % e)

Parameters

Name	Type	Description	Notes
notification_id	str	Params are located in the requests context (tenant id, user email, notification id).	[optional]

Return type

Notificationsv3GetNotificationFilenameResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_get_notification_record

Notificationsv3GetNotificationRecordResponse notifications_service_get_notification_record(notification_id)

Summary: Get notification record Description: Return notifications record with the specified ID.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_get_notification_record_response import Notificationsv3GetNotificationRecordResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notification_id = 'notification_id_example' # str | ID for the record to return.

    try:
        # Summary: Get notification record Description: Return notifications record with the specified ID.
        api_response = api_instance.notifications_service_get_notification_record(notification_id)
        print("The response of NotificationsServiceApi->notifications_service_get_notification_record:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_get_notification_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
notification_id	str	ID for the record to return.

Return type

Notificationsv3GetNotificationRecordResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_get_notification_records

Notificationsv3GetNotificationRecordsResponse notifications_service_get_notification_records(filter_start_time=filter_start_time, filter_end_time=filter_end_time, filter_state=filter_state, filter_origins=filter_origins, filter_origin_data=filter_origin_data, filter_limit=filter_limit, offset=offset, limit=limit, include_filter_counts=include_filter_counts)

Summary: Get notification records Description: Return notifications records that match the specified filter.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_get_notification_records_response import Notificationsv3GetNotificationRecordsResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    filter_start_time = '2013-10-20T19:20:30+01:00' # datetime | Return records created at this time or later (>=). (optional)
    filter_end_time = '2013-10-20T19:20:30+01:00' # datetime | Return records created before this time (<). (optional)
    filter_state = INCLUDE_ALL # str | Only return record that include the specified state. (optional) (default to INCLUDE_ALL)
    filter_origins = ['filter_origins_example'] # List[str] | Only return record that includes the specified origins. (optional)
    filter_origin_data = 'filter_origin_data_example' # str | Only return record that with the specified origin_data. (optional)
    filter_limit = 56 # int | The max amount of rows to return for this single query. (optional)
    offset = 56 # int | The amount to offset the rows by for pagination. (optional)
    limit = 56 # int | The max amount of rows to return for pagination. (optional)
    include_filter_counts = True # bool | Computing the filter counts is relatively expensive, only compute when needed. (optional)

    try:
        # Summary: Get notification records Description: Return notifications records that match the specified filter.
        api_response = api_instance.notifications_service_get_notification_records(filter_start_time=filter_start_time, filter_end_time=filter_end_time, filter_state=filter_state, filter_origins=filter_origins, filter_origin_data=filter_origin_data, filter_limit=filter_limit, offset=offset, limit=limit, include_filter_counts=include_filter_counts)
        print("The response of NotificationsServiceApi->notifications_service_get_notification_records:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_get_notification_records: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter_start_time	datetime	Return records created at this time or later (>=).	[optional]
filter_end_time	datetime	Return records created before this time (<).	[optional]
filter_state	str	Only return record that include the specified state.	[optional] [default to INCLUDE_ALL]
filter_origins	List[str]	Only return record that includes the specified origins.	[optional]
filter_origin_data	str	Only return record that with the specified origin_data.	[optional]
filter_limit	int	The max amount of rows to return for this single query.	[optional]
offset	int	The amount to offset the rows by for pagination.	[optional]
limit	int	The max amount of rows to return for pagination.	[optional]
include_filter_counts	bool	Computing the filter counts is relatively expensive, only compute when needed.	[optional]

Return type

Notificationsv3GetNotificationRecordsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_get_ticket_status

Notificationsv3GetTicketStatusResponse notifications_service_get_ticket_status(ticket_id=ticket_id, integration_id=integration_id)

Summary: Get ticket status Description: Get the status of the given ticket

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_get_ticket_status_response import Notificationsv3GetTicketStatusResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    ticket_id = 'ticket_id_example' # str | The ID of the ticket to fetch. (optional)
    integration_id = 'integration_id_example' # str | The ID of the ticketing integration. (optional)

    try:
        # Summary: Get ticket status Description: Get the status of the given ticket
        api_response = api_instance.notifications_service_get_ticket_status(ticket_id=ticket_id, integration_id=integration_id)
        print("The response of NotificationsServiceApi->notifications_service_get_ticket_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_get_ticket_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
ticket_id	str	The ID of the ticket to fetch.	[optional]
integration_id	str	The ID of the ticketing integration.	[optional]

Return type

Notificationsv3GetTicketStatusResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_post_notification_record

Notificationsv3PostNotificationRecordResponse notifications_service_post_notification_record(notificationsv3_post_notification_record_request)

Summary: For PostNotificationRecord notification only Description: Sends notification with recipients and returns a status

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_post_notification_record_request import Notificationsv3PostNotificationRecordRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_post_notification_record_response import Notificationsv3PostNotificationRecordResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_post_notification_record_request = ibm_gdsc_sdk_saas.Notificationsv3PostNotificationRecordRequest() # Notificationsv3PostNotificationRecordRequest | 

    try:
        # Summary: For PostNotificationRecord notification only Description: Sends notification with recipients and returns a status
        api_response = api_instance.notifications_service_post_notification_record(notificationsv3_post_notification_record_request)
        print("The response of NotificationsServiceApi->notifications_service_post_notification_record:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_post_notification_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_post_notification_record_request	Notificationsv3PostNotificationRecordRequest

Return type

Notificationsv3PostNotificationRecordResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_search_notification_records

Notificationsv3SearchNotificationRecordsResponse notifications_service_search_notification_records(notificationsv3_search_notification_records_request)

Summary: Search notification records Description: Return notification records using pipeline of filters

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_search_notification_records_request import Notificationsv3SearchNotificationRecordsRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_search_notification_records_response import Notificationsv3SearchNotificationRecordsResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_search_notification_records_request = ibm_gdsc_sdk_saas.Notificationsv3SearchNotificationRecordsRequest() # Notificationsv3SearchNotificationRecordsRequest | 

    try:
        # Summary: Search notification records Description: Return notification records using pipeline of filters
        api_response = api_instance.notifications_service_search_notification_records(notificationsv3_search_notification_records_request)
        print("The response of NotificationsServiceApi->notifications_service_search_notification_records:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_search_notification_records: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_search_notification_records_request	Notificationsv3SearchNotificationRecordsRequest

Return type

Notificationsv3SearchNotificationRecordsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_test_integration

Notificationsv3TestIntegrationResponse notifications_service_test_integration(notificationsv3_test_integration_request)

Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest. When possible a test message is sent to the integration to ensure it is functional.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_test_integration_request import Notificationsv3TestIntegrationRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_test_integration_response import Notificationsv3TestIntegrationResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_test_integration_request = ibm_gdsc_sdk_saas.Notificationsv3TestIntegrationRequest() # Notificationsv3TestIntegrationRequest | 

    try:
        # Summary: Test integration Description: Test the integration connection with the arguments passed in the TestIntegrationRequest.  When possible a test message is sent to the integration to ensure it is functional.
        api_response = api_instance.notifications_service_test_integration(notificationsv3_test_integration_request)
        print("The response of NotificationsServiceApi->notifications_service_test_integration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_test_integration: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_test_integration_request	Notificationsv3TestIntegrationRequest

Return type

Notificationsv3TestIntegrationResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

notifications_service_update_notification_record

Notificationsv3UpdateNotificationRecordResponse notifications_service_update_notification_record(notificationsv3_update_notification_record_request)

Summary: Update notification record Description: Update a notification record with the specified values. The ID field is required and must match an existing notification. All fields other than the ID are optional. Creation timestamp, user and other administrative fields can not updated.

Example

Basic Authentication (BasicAuth):
Api Key Authentication (ApiKeyAuth):

import ibm_gdsc_sdk_saas,os
from ibm_gdsc_sdk_saas.models.notificationsv3_update_notification_record_request import Notificationsv3UpdateNotificationRecordRequest
from ibm_gdsc_sdk_saas.models.notificationsv3_update_notification_record_response import Notificationsv3UpdateNotificationRecordResponse
from ibm_gdsc_sdk_saas.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ibm_gdsc_sdk_saas.Configuration(
    host = "http://localhost"
)

# 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 HTTP basic authorization: BasicAuth
configuration = ibm_gdsc_sdk_saas.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# 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 ibm_gdsc_sdk_saas.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibm_gdsc_sdk_saas.NotificationsServiceApi(api_client)
    notificationsv3_update_notification_record_request = ibm_gdsc_sdk_saas.Notificationsv3UpdateNotificationRecordRequest() # Notificationsv3UpdateNotificationRecordRequest | 

    try:
        # Summary: Update notification record Description: Update a notification record with the specified values.  The ID field is required and must match an existing notification. All fields other than the ID are optional. Creation timestamp, user and other administrative fields can not updated.
        api_response = api_instance.notifications_service_update_notification_record(notificationsv3_update_notification_record_request)
        print("The response of NotificationsServiceApi->notifications_service_update_notification_record:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsServiceApi->notifications_service_update_notification_record: %s\n" % e)

Parameters

Name	Type	Description	Notes
notificationsv3_update_notification_record_request	Notificationsv3UpdateNotificationRecordRequest

Return type

Notificationsv3UpdateNotificationRecordResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

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

FilesExpand file tree

NotificationsServiceApi.md

Latest commit

History

NotificationsServiceApi.md

File metadata and controls

ibm_gdsc_sdk_saas.NotificationsServiceApi

notifications_service_create_ticket

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_get_folders

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_get_notification_filename

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_get_notification_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_get_notification_records

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_get_ticket_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_post_notification_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_search_notification_records

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_test_integration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notifications_service_update_notification_record

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details