eliona.api_client.AlarmsApi

All URIs are relative to https://name.eliona.io/v2

Method	HTTP request	Description
delete_alarm_by_id	DELETE /alarms/{alarm-rule-id}	Removes an alarm
get_alarm_by_id	GET /alarms/{alarm-rule-id}	Information about alarm
get_alarm_history_by_id	GET /alarms-history/{alarm-rule-id}	Information about alarm history
get_alarms	GET /alarms	Information about alarms
get_alarms_history	GET /alarms-history	Information about alarms history
get_highest_alarms	GET /alarms-highest	Information about most prioritized alarms
listen_alarm	GET /alarm-listener	WebSocket connection for alarm changes
patch_alarm_by_id	PATCH /alarms/{alarm-rule-id}	Update alarm
put_alarm	PUT /alarms	Create or update an alarm

delete_alarm_by_id

delete_alarm_by_id(alarm_rule_id)

Removes an alarm

Marks an alarm as gone

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    alarm_rule_id = 4711 # int | The id of the alarm rule

    # example passing only required values which don't have defaults set
    try:
        # Removes an alarm
        api_instance.delete_alarm_by_id(alarm_rule_id)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->delete_alarm_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
alarm_rule_id	int	The id of the alarm rule

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successfully removes an alarm	-
404	Alarm with alarm rule id not found	-

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

get_alarm_by_id

Alarm get_alarm_by_id(alarm_rule_id)

Information about alarm

Gets information about alarm.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    alarm_rule_id = 4711 # int | The id of the alarm rule
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Information about alarm
        api_response = api_instance.get_alarm_by_id(alarm_rule_id)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarm_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about alarm
        api_response = api_instance.get_alarm_by_id(alarm_rule_id, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarm_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
alarm_rule_id	int	The id of the alarm rule
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

Alarm

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned an alarm	-
404	Alarm with id not found	-

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

get_alarm_history_by_id

[Alarm] get_alarm_history_by_id(alarm_rule_id)

Information about alarm history

Gets information about alarm over the entire time. This includes current alarm and history.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    alarm_rule_id = 4711 # int | The id of the alarm rule
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Information about alarm history
        api_response = api_instance.get_alarm_history_by_id(alarm_rule_id)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarm_history_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about alarm history
        api_response = api_instance.get_alarm_history_by_id(alarm_rule_id, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarm_history_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
alarm_rule_id	int	The id of the alarm rule
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

[Alarm]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of alarms	-

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

get_alarms

[Alarm] get_alarms()

Information about alarms

Gets information about alarms

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    project_id = "projectId_example" # str, none_type | Filter for a specific project (optional)
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about alarms
        api_response = api_instance.get_alarms(project_id=project_id, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarms: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str, none_type	Filter for a specific project	[optional]
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

[Alarm]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of alarms	-

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

get_alarms_history

[Alarm] get_alarms_history()

Information about alarms history

Gets information about alarms over the entire time. This includes current alarms and alarms, which are already processed.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    project_id = "projectId_example" # str, none_type | Filter for a specific project (optional)
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about alarms history
        api_response = api_instance.get_alarms_history(project_id=project_id, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_alarms_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str, none_type	Filter for a specific project	[optional]
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

[Alarm]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of alarms	-

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

get_highest_alarms

[Alarm] get_highest_alarms()

Information about most prioritized alarms

Gets information about an alarms with the highest priority for each asset.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    project_id = "projectId_example" # str, none_type | Filter for a specific project (optional)
    expansions = [
        "expansions_example",
    ] # [str], none_type | List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Information about most prioritized alarms
        api_response = api_instance.get_highest_alarms(project_id=project_id, expansions=expansions)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->get_highest_alarms: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str, none_type	Filter for a specific project	[optional]
expansions	[str], none_type	List of referenced data to load, insert or update. Each entry defines the full qualified name of the field to be expanded as follows 'ObjectName.fieldName'.	[optional]

Return type

[Alarm]

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully returned a list of most prioritized alarms	-

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

listen_alarm

AlarmListen listen_alarm()

WebSocket connection for alarm changes

Open a WebSocket connection to get informed when new alarm data is written or anything changes.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm_listen import AlarmListen
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # WebSocket connection for alarm changes
        api_response = api_instance.listen_alarm()
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->listen_alarm: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AlarmListen

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successfully opened a connection to alarm WebSocket	-

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

patch_alarm_by_id

patch_alarm_by_id(alarm_rule_id, acknowledged)

Update alarm

Update properties of alarm for given id.

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    alarm_rule_id = 4711 # int | The id of the alarm rule
    acknowledged = True # bool | Marks the alarm as acknowledged or not acknowledged by setting the acknowledge timestamp to now or to null.
    acknowledge_text = "acknowledgeText_example" # str | Sets the text for acknowledgement if acknowledged is set to true (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update alarm
        api_instance.patch_alarm_by_id(alarm_rule_id, acknowledged)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->patch_alarm_by_id: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update alarm
        api_instance.patch_alarm_by_id(alarm_rule_id, acknowledged, acknowledge_text=acknowledge_text)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->patch_alarm_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
alarm_rule_id	int	The id of the alarm rule
acknowledged	bool	Marks the alarm as acknowledged or not acknowledged by setting the acknowledge timestamp to now or to null.
acknowledge_text	str	Sets the text for acknowledgement if acknowledged is set to true	[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Successfully updated the alarm	-

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

put_alarm

Alarm put_alarm(alarm)

Create or update an alarm

Creates or updates an alarm

Example

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

import time
import eliona.api_client
from eliona.api_client.api import alarms_api
from eliona.api_client.model.alarm import Alarm
from pprint import pprint
# Defining the host is optional and defaults to https://name.eliona.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = eliona.api_client.Configuration(
    host = "https://name.eliona.io/v2"
)

# 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): BearerAuth
configuration = eliona.api_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with eliona.api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = alarms_api.AlarmsApi(api_client)
    alarm = Alarm(
        priority=1,
        requires_acknowledge=False,
        value=38.7,
        timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),
        message={},
        asset_info=Asset(
            resource_id="123e4567-e89b-12d3-a456-426655440000",
            device_ids=["XYZ0123",173493272],
            project_id="99",
            global_asset_identifier="zurich_swiss",
            name="Station Zurich",
            asset_type="asset_type_example",
            latitude=47.3667,
            longitude=8.55,
            is_tracker=False,
            tracker_id=4711,
            description="Weather station Zurich, Swiss",
            parent_functional_asset_id=4712,
            parent_locational_asset_id=4712,
            parent_functional_identifier="4712",
            parent_locational_identifier="4712",
            tags=["weather","location"],
            attachments=[
                Attachment(
                    name="example.gif",
                    content_type="image/png",
                    encoding="base64",
                    content="iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
                ),
            ],
        ),
        rule_info=AlarmRule(
            asset_id=4711,
            subtype=DataSubtype("input"),
            attribute="temperature",
            enable=True,
            priority=AlarmPriority(2),
            requires_acknowledge=False,
            equal=38.7,
            low=38.7,
            high=38.7,
            message={},
            tags=[
                "tags_example",
            ],
            subject="subject_example",
            urldoc="urldoc_example",
            params={},
            notify_on="R",
            dont_mask=False,
            check_type="limits",
            asset_info=Asset(
                resource_id="123e4567-e89b-12d3-a456-426655440000",
                device_ids=["XYZ0123",173493272],
                project_id="99",
                global_asset_identifier="zurich_swiss",
                name="Station Zurich",
                asset_type="asset_type_example",
                latitude=47.3667,
                longitude=8.55,
                is_tracker=False,
                tracker_id=4711,
                description="Weather station Zurich, Swiss",
                parent_functional_asset_id=4712,
                parent_locational_asset_id=4712,
                parent_functional_identifier="4712",
                parent_locational_identifier="4712",
                tags=["weather","location"],
                attachments=[
                    Attachment(
                        name="example.gif",
                        content_type="image/png",
                        encoding="base64",
                        content="iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
                    ),
                ],
            ),
        ),
    ) # Alarm | 

    # example passing only required values which don't have defaults set
    try:
        # Create or update an alarm
        api_response = api_instance.put_alarm(alarm)
        pprint(api_response)
    except eliona.api_client.ApiException as e:
        print("Exception when calling AlarmsApi->put_alarm: %s\n" % e)

Parameters

Name	Type	Description	Notes
alarm	Alarm

Return type

Alarm

Authorization

ApiKeyAuth, BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successfully created a new or updated an existing alarm	-

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

Files

AlarmsApi.md

Latest commit

History

AlarmsApi.md

File metadata and controls

eliona.api_client.AlarmsApi

delete_alarm_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_alarm_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_alarm_history_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_alarms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_alarms_history

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_highest_alarms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listen_alarm

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_alarm_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_alarm

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details