EVerest API definition for error history (consumer) 1.0.0 documentation

EVerest API definition for error history (consumer) 1.0.0

Apache-2.0
application/json
ID: pionix:de:everest:error_history_consumer_API

API for EVerest API clients for error status and history.

#EVerest
#Auth

Servers

mqtt://localhost:1883/everest_api/1/error_history_consumer/{module_id}mqttdefault
default local MQTT

object
module_id
required
string
The ID of the module as defined in the EVerest config file.

Operations

REQUEST m2e/get_errors
Direction: Module to EVerest

Operation IDsend_request_get_errors
Available only on servers:
- default
Accepts the following message:
Request the list of filtered errorssend_request_get_errors
Request the list of filtered errors.
application/json
Message IDsend_request_get_errors
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
object
Arguments for the get_errors command

state_filter
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
type_filter
string
severity_filter
string
Severity filter for errors

Allowed values:
"HIGH_GE"
"MEDIUM_GE"
"LOW_GE"
object
Timeperiod filter for errors

timestamp_from
required
string
format: date-time
timestamp_to
required
string
format: date-time
Additional properties are allowed.
handle_filter
string
Handle of an error

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "headers": { "replyTo": "string" }, "payload": { "state_filter": "Active", "origin_filter": { "module_id": "string", "implementation_id": "string" }, "type_filter": "string", "severity_filter": "HIGH_GE", "timeperiod_filter": { "timestamp_from": "2019-08-24T14:15:22Z", "timestamp_to": "2019-08-24T14:15:22Z" }, "handle_filter": "string" } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
List of filtered errorsreceive_reply_get_errors
Reply to the request to send the list of filtered errors
application/json
Message IDreceive_reply_get_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "errors": [ { "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" } ] }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Direction: EVerest to Module

Operation IDreceive_reply_get_errors
Available only on servers:
- default
Accepts the following message:
List of filtered errorsreceive_reply_get_errors
Reply to the request to send the list of filtered errors
application/json
Message IDreceive_reply_get_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "errors": [ { "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" } ] }

This example has been generated automatically.
REQUEST m2e/active_errors
Direction: Module to EVerest

Operation IDsend_request_active_errors
Available only on servers:
- default
Accepts the following message:
Request the list of active errorssend_request_active_errors
Request the list of active errors.
application/json
Message IDsend_request_active_errors
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
Examples
#1 Example
Request active errors
{ "headers": { "replyTo": "everest_api/1.0/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}" } }
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
Available only on servers:
default
Message:
The list of active errorsreceive_reply_active_errors
Reply to the request to send the list of active errors
application/json
Message IDreceive_reply_active_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "errors": [ { "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" } ] }

This example has been generated automatically.

REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
RECEIVE
Direction: EVerest to Module

Operation IDreceive_reply_active_errors
Available only on servers:
- default
Accepts the following message:
The list of active errorsreceive_reply_active_errors
Reply to the request to send the list of active errors
application/json
Message IDreceive_reply_active_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "errors": [ { "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" } ] }

This example has been generated automatically.
RECEIVE e2m/error_raised
Operation IDreceive_error_raised
Available only on servers:
- default
Accepts the following message:
Receive newly raised errorreceive_error_raised
Notifies on every raised error
application/json
Message IDreceive_error_raised
object
Represents an error

type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" }

This example has been generated automatically.
RECEIVE e2m/error_cleared
Operation IDreceive_error_cleared
Available only on servers:
- default
Accepts the following message:
Receive cleared errorreceive_error_cleared
Notifies when an error is cleared
application/json
Message IDreceive_error_cleared
object
Represents an error

type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
Examples
{ "type": "string", "sub_type": "string", "description": "string", "message": "string", "severity": "High", "origin": { "module_id": "string", "implementation_id": "string" }, "timestamp": "2019-08-24T14:15:22Z", "uuid": "string", "state": "Active" }

This example has been generated automatically.
RECEIVE e2m/heartbeat
Operation IDreceive_heartbeat
Available only on servers:
- default
Accepts the following message:
Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

Examples
#1 Example
Heartbeat
42
SEND m2e/communication_check
Operation IDsend_communication_check
Available only on servers:
- default
Accepts the following message:
Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Examples
#1 Example
CommunicationCheck

Messages

#1Request the list of filtered errorssend_request_get_errors
Request the list of filtered errors.
- application/json
Message IDsend_request_get_errors
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
object
Arguments for the get_errors command

state_filter
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
type_filter
string
severity_filter
string
Severity filter for errors

Allowed values:
"HIGH_GE"
"MEDIUM_GE"
"LOW_GE"
object
Timeperiod filter for errors

timestamp_from
required
string
format: date-time
timestamp_to
required
string
format: date-time
Additional properties are allowed.
handle_filter
string
Handle of an error

Additional properties are allowed.
Additional properties are allowed.
#2List of filtered errorsreceive_reply_get_errors
Reply to the request to send the list of filtered errors
- application/json
Message IDreceive_reply_get_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
#3Request the list of active errorssend_request_active_errors
Request the list of active errors.
- application/json
Message IDsend_request_active_errors
object
object
replyTo
string
Address to send the response to.

Additional properties are allowed.
Additional properties are allowed.
#4The list of active errorsreceive_reply_active_errors
Reply to the request to send the list of active errors
- application/json
Message IDreceive_reply_active_errors
object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
#5Receive newly raised errorreceive_error_raised
Notifies on every raised error
- application/json
Message IDreceive_error_raised
object
Represents an error

type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
#6Receive cleared errorreceive_error_cleared
Notifies when an error is cleared
- application/json
Message IDreceive_error_cleared
object
Represents an error

type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
#7Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
- application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
#8Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
- application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Schemas

object
A list of ErrorObjects

required
array<object>
type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
object
Represents an error

type
required
string
>= 2 characters
sub_type
string
description
required
string
>= 2 characters
message
required
string
>= 2 characters
severity
required
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
required
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
timestamp
required
string
format: date-time
uuid
required
string
>= 2 characters
state
required
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
Additional properties are allowed.
object
Arguments for the get_errors command

state_filter
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
type_filter
string
severity_filter
string
Severity filter for errors

Allowed values:
"HIGH_GE"
"MEDIUM_GE"
"LOW_GE"
object
Timeperiod filter for errors

timestamp_from
required
string
format: date-time
timestamp_to
required
string
format: date-time
Additional properties are allowed.
handle_filter
string
Handle of an error

Additional properties are allowed.
object
Identifier of an implementation

module_id
required
string
>= 2 characters
implementation_id
required
string
>= 2 characters
Additional properties are allowed.
Severity
string
Severity of an error

Allowed values:
"High"
"Medium"
"Low"
SeverityFilter
string
Severity filter for errors

Allowed values:
"HIGH_GE"
"MEDIUM_GE"
"LOW_GE"
State
string
State of an error

Allowed values:
"Active"
"ClearedByModule"
"ClearedByReboot"
object
Timeperiod filter for errors

timestamp_from
required
string
format: date-time
timestamp_to
required
string
format: date-time
Additional properties are allowed.
CommunicationCheck
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
HeartBeatId
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

EVerest API definition for error history (consumer) 1.0.0

Servers

Operations

REQUEST m2e/get_errors

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

REQUEST m2e/active_errors

Examples

#1 Example

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

REPLY address information

RECEIVE

Examples

This example has been generated automatically.

RECEIVE e2m/error_raised

Examples

This example has been generated automatically.

RECEIVE e2m/error_cleared

Examples

This example has been generated automatically.

RECEIVE e2m/heartbeat

Examples

#1 Example

SEND m2e/communication_check

Examples

#1 Example

Messages

Schemas