libica.openapi.v2.EventLogApi¶
All URIs are relative to /ica/rest
| Method | HTTP request | Description |
|---|---|---|
| get_event_logs | GET /api/eventLog | Retrieve a list of event logs. |
| search_event_logs | POST /api/eventLog:search | Search event logs. |
get_event_logs¶
EventLogListV3 get_event_logs()
Retrieve a list of event logs.
Example¶
- Api Key Authentication (ApiKeyAuth):
- Bearer (JWT) Authentication (JwtAuth):
import time
import libica.openapi.v2
from libica.openapi.v2.api import event_log_api
from libica.openapi.v2.model.event_log_list_v3 import EventLogListV3
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 = event_log_api.EventLogApi(api_client)
code = "code_example" # str | Code (optional)
code_filter_type = "STARTS_WITH" # str | Code filter type (optional)
category = "ERROR" # str | Category (optional)
date_from = "dateFrom_example" # str | Date from. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' eg: 2017-01-10T10:47:56.039Z (optional)
date_until = "dateUntil_example" # str | Date until. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' eg: 2017-01-10T10:47:56.039Z (optional)
rows = 250 # int | Amount of rows to fetch (chronologically oldest first). Maximum 250. Defaults to 250 (optional) if omitted the server will use the default value of 250
# example passing only required values which don't have defaults set
# and optional values
try:
# Retrieve a list of event logs.
api_response = api_instance.get_event_logs(code=code, code_filter_type=code_filter_type, category=category, date_from=date_from, date_until=date_until, rows=rows)
pprint(api_response)
except libica.openapi.v2.ApiException as e:
print("Exception when calling EventLogApi->get_event_logs: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| code | str | Code | [optional] |
| code_filter_type | str | Code filter type | [optional] |
| category | str | Category | [optional] |
| date_from | str | Date from. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' eg: 2017-01-10T10:47:56.039Z | [optional] |
| date_until | str | Date until. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' eg: 2017-01-10T10:47:56.039Z | [optional] |
| rows | int | Amount of rows to fetch (chronologically oldest first). Maximum 250. Defaults to 250 | [optional] if omitted the server will use the default value of 250 |
Return type¶
Authorization¶
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 event logs is successfully retrieved. | - |
| 0 | A problem occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
search_event_logs¶
EventLogPagedListV4 search_event_logs()
Search event logs.
Example¶
- Api Key Authentication (ApiKeyAuth):
- Bearer (JWT) Authentication (JwtAuth):
import time
import libica.openapi.v2
from libica.openapi.v2.api import event_log_api
from libica.openapi.v2.model.event_log_query_parameters_v4 import EventLogQueryParametersV4
from libica.openapi.v2.model.event_log_paged_list_v4 import EventLogPagedListV4
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 = event_log_api.EventLogApi(api_client)
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: - timeCreated (optional)
event_log_query_parameters_v4 = EventLogQueryParametersV4(
code="code_example",
category="INF",
date_from=dateutil_parser('1970-01-01T00:00:00.00Z'),
date_until=dateutil_parser('1970-01-01T00:00:00.00Z'),
) # EventLogQueryParametersV4 | (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Search event logs.
api_response = api_instance.search_event_logs(page_offset=page_offset, page_token=page_token, page_size=page_size, sort=sort, event_log_query_parameters_v4=event_log_query_parameters_v4)
pprint(api_response)
except libica.openapi.v2.ApiException as e:
print("Exception when calling EventLogApi->search_event_logs: %s\n" % e)
Parameters¶
| Name | Type | Description | Notes |
|---|---|---|---|
| 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: - timeCreated | [optional] |
| event_log_query_parameters_v4 | EventLogQueryParametersV4 | [optional] |
Return type¶
Authorization¶
HTTP request headers¶
- Content-Type: application/vnd.illumina.v4+json, application/json
- Accept: application/problem+json, application/vnd.illumina.v4+json
HTTP response details¶
| Status code | Description | Response headers |
|---|---|---|
| 200 | The list of event logs is successfully retrieved. | - |
| 0 | A problem occurred. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]