Namirasoft Alarm API V1
Namira Software Corporation Alarm API Version 1 (1.4.12)
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} {user_id}
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} {user_id}
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 (String)
Update
Updates a alarm field by an id for an entity
ns-alarm alarmfield update {entity_id} {id}
--field_id (String)
--value (String)
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} {user_id}
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} {user_id}
Get
Returns an alarm by an id
ns-alarm alarm get {id}
Create
Creates a new alarm
ns-alarm alarm create
--product_id (String)
--topic_id (String)
--name (String)
--entity (String)
--action (String)
--filters (String)
--description (String)
--alarm_category (Array)
--alarm_field (Array)
--alarm_tag (Array)
Update
Updates an alarm by an id
ns-alarm alarm update {id}
--product_id (String)
--topic_id (String)
--name (String)
--entity (String)
--action (String)
--filters (String)
--description (String)
--alarm_category (Array)
--alarm_field (Array)
--alarm_tag (Array)
Delete
Deletes an alarm by an id
ns-alarm alarm delete {id}
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": "String", "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": "String", "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 }, "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 }, "description": { "type": "String", "required": false, "max": 255 }, "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 }, "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 }, "description": { "type": "String", "required": false, "max": 255 }, "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": "String", "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": { "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 }, "description": { "type": "String", "required": false, "max": 255 }, "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": "String", "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 } } } ] } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.