Namirasoft Alarm API V1
Namira Software Corporation Alarm API Version 1 (1.4.25)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-alarm-api-v1
Commands
Healthz
Get
Returns the application health status
ns-alarm healthz get
Value
List
Returns the value list of a given table and column
ns-alarm value list {table} {column} {search} {field_id} {limit}
AlarmCategory
List
Returns the alarm category list
ns-alarm alarmcategory list {filters} {page} {size} {sorts}
Get
Returns a alarm category by id.
ns-alarm alarmcategory get {id}
Create
Creates a new alarm category for an entity
ns-alarm alarmcategory create {entity_id}
--category_id (String)
Delete
Deletes a alarm category by an id.
ns-alarm alarmcategory delete {entity_id} {id}
AlarmField
List
Returns the alarm field list
ns-alarm alarmfield list {filters} {page} {size} {sorts}
Get
Returns a alarm field by id.
ns-alarm alarmfield get {id}
Create
Creates a new alarm field for an entity
ns-alarm alarmfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a alarm field by an id for an entity
ns-alarm alarmfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a alarm field by an id.
ns-alarm alarmfield delete {entity_id} {id}
AlarmTag
List
Returns the alarm tag list
ns-alarm alarmtag list {filters} {page} {size} {sorts}
Get
Returns a alarm tag by id.
ns-alarm alarmtag get {id}
Create
Creates a new alarm tag for an entity
ns-alarm alarmtag create {entity_id}
--name (String)
--value (String)
Update
Updates a alarm tag by an id for an entity
ns-alarm alarmtag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a alarm tag by an id.
ns-alarm alarmtag delete {entity_id} {id}
Alarm
List
Returns the alarm list
ns-alarm alarm list {filters} {page} {size} {sorts}
Get
Returns an alarm by an id
ns-alarm alarm get {id}
Create
Creates a new alarm
ns-alarm alarm create
--workspace_id (String)
--product_id (String)
--topic_id (String)
--name (String)
--entity (String)
--action (String)
--filters (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay_value (Integer)
--delay_unit (Enum)
--aggregation (Boolean)
--aggregation_interval_value (Integer)
--aggregation_interval_unit (Enum)
--aggregation_function (Enum)
--aggregation_column (String)
--aggregation_operator (Enum)
--aggregation_value (Integer)
--description (String)
--alarm_category (Array)
--alarm_field (Array)
--alarm_tag (Array)
Update
Updates an alarm by an id
ns-alarm alarm update {id}
--workspace_id (String)
--product_id (String)
--topic_id (String)
--name (String)
--entity (String)
--action (String)
--filters (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay_value (Integer)
--delay_unit (Enum)
--aggregation (Boolean)
--aggregation_interval_value (Integer)
--aggregation_interval_unit (Enum)
--aggregation_function (Enum)
--aggregation_column (String)
--aggregation_operator (Enum)
--aggregation_value (Integer)
--description (String)
--alarm_category (Array)
--alarm_field (Array)
--alarm_tag (Array)
Delete
Deletes an alarm by an id
ns-alarm alarm delete {id}
Product
List
Returns the product list
ns-alarm product list {filters} {page} {size} {sorts}
Get
Returns a product by an id
ns-alarm product get {id}
_Set
Sets all the required access of a product
ns-alarm product _set {product_id}
@row_option_text
<@row_option@>Schemas
AlarmCategory
{ "name": "AlarmCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
AlarmField
{ "name": "AlarmField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
AlarmTag
{ "name": "AlarmTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Alarm
{ "name": "Alarm", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "entity": { "type": "String", "required": false, "max": 255 }, "action": { "type": "String", "required": false, "max": 255 }, "filters": { "type": "String", "required": false, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "AlarmLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay_value": { "type": "Integer", "required": true }, "delay_unit": { "name": "AlarmDelayUnit", "type": "Enum", "required": true, "valids": [ "MilliSecond", "Second", "Minute", "Hour" ] }, "aggregation": { "type": "Boolean", "required": true }, "aggregation_interval_value": { "type": "Integer", "required": false }, "aggregation_interval_unit": { "name": "AlarmAggregationIntervalUnit", "type": "Enum", "required": false, "valids": [ "Minute", "Hour" ] }, "aggregation_function": { "name": "AlarmAggregationFunction", "type": "Enum", "required": false, "valids": [ "Count", "Min", "Max", "Avg", "Sum" ] }, "aggregation_column": { "type": "String", "required": false, "max": 255 }, "aggregation_operator": { "name": "AlarmAggregationOperator", "type": "Enum", "required": false, "valids": [ "Greater", "Less", "GreaterEqual", "LessEqual" ] }, "aggregation_value": { "type": "Integer", "required": false }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AlarmFull
{ "name": "AlarmFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "entity": { "type": "String", "required": false, "max": 255 }, "action": { "type": "String", "required": false, "max": 255 }, "filters": { "type": "String", "required": false, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "AlarmLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay_value": { "type": "Integer", "required": true }, "delay_unit": { "name": "AlarmDelayUnit", "type": "Enum", "required": true, "valids": [ "MilliSecond", "Second", "Minute", "Hour" ] }, "aggregation": { "type": "Boolean", "required": true }, "aggregation_interval_value": { "type": "Integer", "required": false }, "aggregation_interval_unit": { "name": "AlarmAggregationIntervalUnit", "type": "Enum", "required": false, "valids": [ "Minute", "Hour" ] }, "aggregation_function": { "name": "AlarmAggregationFunction", "type": "Enum", "required": false, "valids": [ "Count", "Min", "Max", "Avg", "Sum" ] }, "aggregation_column": { "type": "String", "required": false, "max": 255 }, "aggregation_operator": { "name": "AlarmAggregationOperator", "type": "Enum", "required": false, "valids": [ "Greater", "Less", "GreaterEqual", "LessEqual" ] }, "aggregation_value": { "type": "Integer", "required": false }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "alarm_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "alarm_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "alarm_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
AlarmInput
{ "name": "AlarmInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "entity": { "type": "String", "required": false, "max": 255 }, "action": { "type": "String", "required": false, "max": 255 }, "filters": { "type": "String", "required": false, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "AlarmLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay_value": { "type": "Integer", "required": true }, "delay_unit": { "name": "AlarmDelayUnit", "type": "Enum", "required": true, "valids": [ "MilliSecond", "Second", "Minute", "Hour" ] }, "aggregation": { "type": "Boolean", "required": true }, "aggregation_interval_value": { "type": "Integer", "required": false }, "aggregation_interval_unit": { "name": "AlarmAggregationIntervalUnit", "type": "Enum", "required": false, "valids": [ "Minute", "Hour" ] }, "aggregation_function": { "name": "AlarmAggregationFunction", "type": "Enum", "required": false, "valids": [ "Count", "Min", "Max", "Avg", "Sum" ] }, "aggregation_column": { "type": "String", "required": false, "max": 255 }, "aggregation_operator": { "name": "AlarmAggregationOperator", "type": "Enum", "required": false, "valids": [ "Greater", "Less", "GreaterEqual", "LessEqual" ] }, "aggregation_value": { "type": "Integer", "required": false }, "description": { "type": "String", "required": false }, "alarm_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "alarm_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "alarm_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Product
{ "name": "Product", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "alarm": { "type": "Any", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Enums
AlarmLimitPerUnit
Second
Minute
Hour
Day
AlarmDelayUnit
MilliSecond
Second
Minute
Hour
AlarmAggregationIntervalUnit
Minute
Hour
AlarmAggregationFunction
Count
Min
Max
Avg
Sum
AlarmAggregationOperator
Greater
Less
GreaterEqual
LessEqual
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.