nisystemlink.clients.alarm
- class nisystemlink.clients.alarm.AlarmClient(configuration=None)[source]
- __init__(configuration=None)[source]
Initialize an instance.
- Parameters
configuration (
Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, theHttpConfigurationManageris used to obtain the configuration.- Raises
ApiException – if unable to communicate with the /nialarm Service.
- create_or_update_alarm(request, *, ignore_conflict=False)[source]
Creates or updates an instance, or occurrence, of an alarm.
Creates or updates an alarm based on the requested transition and the state of the current active alarm with the given alarm_id (specified in the request). Multiple calls with the same alarm_id will update the same alarm instance.
- Parameters
request (
nisystemlink.clients.alarm.models.CreateOrUpdateAlarmRequest) – The request containing alarm_id (user-defined identifier), transition details, and other alarm properties.ignore_conflict (
bool) – If True, 409 Conflict errors will be ignored and None will be returned. If False (default), 409 errors will raise an ApiException. Setting this to True is useful for stateless applications that want to attempt state transitions without checking the current alarm state first.
- Return type
Optional[str]- Returns
The instance_id (unique occurrence identifier) of the created or modified alarm. Use this ID for operations like get_alarm(), delete_alarm(), or acknowledge. Returns None if ignore_conflict is True and a 409 Conflict occurs.
- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments. A 409 Conflict error occurs when the request does not represent a valid transition for an existing alarm, such as attempting to clear an alarm which is already clear, or attempting to set an alarm which is already set at the given severity level. This error can be suppressed by setting ignore_conflict=True.
- get_alarm(instance_id)[source]
Gets an alarm by its instance_id.
- Parameters
instance_id (
str) – The unique instance ID (occurrence identifier) of the alarm to retrieve. This is the server-generated ID returned from create_or_update_alarm(), not the user-defined alarm_id.- Return type
- Returns
The alarm with the specified instance_id.
- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments.
- delete_alarm(instance_id)[source]
Deletes an alarm by its instance_id.
- Parameters
instance_id (
str) – The unique instance ID (occurrence identifier) of the alarm to delete. This is the server-generated ID returned from create_or_update_alarm(), not the user-defined alarm_id.- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments.
- Return type
None
- delete_alarms(instance_ids)[source]
Deletes multiple alarm instances by their instance IDs.
- Parameters
instance_ids (
List[str]) – List of instance IDs (unique occurrence identifiers) of the alarms to delete. These are the server-generated IDs returned when creating/updating alarms, not the user-defined alarm_id.- Return type
- Returns
A response containing lists of successfully deleted and failed instance IDs, along with error information for failures.
- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments.
- acknowledge_alarms(instance_ids, *, force_clear=False)[source]
Acknowledges one or more alarm instances by their instance IDs.
- Parameters
instance_ids (
List[str]) – List of instance IDs (unique occurrence identifiers) of the alarms to acknowledge. These are the server-generated IDs returned when creating/updating alarms, not the user-defined alarm_id.force_clear (
bool) – Whether or not the affected alarms should have their clear field set to true. Defaults to False.
- Return type
- Returns
A response containing the instance IDs that were successfully acknowledged, the instance IDs that failed, and error details for failures.
- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments.
- query_alarms(request)[source]
Queries for instances, or occurrences, of alarms using Dynamic LINQ.
Specifying an empty JSON object in the request body will result in all alarms being returned.
- Parameters
request (
nisystemlink.clients.alarm.models.QueryAlarmsWithFilterRequest) – The request containing filter information and query options.- Return type
nisystemlink.clients.alarm.models.QueryAlarmsWithFilterResponse- Returns
A response containing the list of alarms that match the query, along with optional total count and continuation token for pagination.
- Raises
ApiException – if unable to communicate with the /nialarm Service or provided invalid arguments.
- pydantic model nisystemlink.clients.alarm.models.AcknowledgeAlarmsResponse[source]
Contains information about which alarms were acknowledged.
Show JSON schema
{ "title": "AcknowledgeAlarmsResponse", "description": "Contains information about which alarms were acknowledged.", "type": "object", "properties": { "failed": { "items": { "type": "string" }, "title": "Failed", "type": "array" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "acknowledged": { "items": { "type": "string" }, "title": "Acknowledged", "type": "array" } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } }, "required": [ "failed", "acknowledged" ] }
- Fields
-
field acknowledged:
List[str] [Required] The instanceIds of the alarms that were successfully acknowledged.
- pydantic model nisystemlink.clients.alarm.models.Alarm[source]
An individual instance, or occurrence, of an alarm.
The lifecycle of an alarm begins the first time it is triggered and ends when it has been both acknowledged and cleared. The service enforces the invariant that there can be at most one active=True alarm with the same alarmId.
Show JSON schema
{ "title": "Alarm", "description": "An individual instance, or occurrence, of an alarm.\n\nThe lifecycle of an alarm begins the first time it is triggered and ends when it has been\nboth acknowledged and cleared. The service enforces the invariant that there can be at most\none active=True alarm with the same alarmId.", "type": "object", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "alarmId": { "title": "Alarmid", "type": "string" }, "workspace": { "title": "Workspace", "type": "string" }, "active": { "title": "Active", "type": "boolean" }, "clear": { "title": "Clear", "type": "boolean" }, "acknowledged": { "title": "Acknowledged", "type": "boolean" }, "acknowledgedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Acknowledgedat" }, "acknowledgedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acknowledgedby" }, "occurredAt": { "format": "date-time", "title": "Occurredat", "type": "string" }, "updatedAt": { "format": "date-time", "title": "Updatedat", "type": "string" }, "createdBy": { "title": "Createdby", "type": "string" }, "transitions": { "items": { "$ref": "#/$defs/AlarmTransition" }, "title": "Transitions", "type": "array" }, "transitionOverflowCount": { "title": "Transitionoverflowcount", "type": "integer" }, "notificationStrategyIds": { "items": { "type": "string" }, "title": "Notificationstrategyids", "type": "array" }, "currentSeverityLevel": { "title": "Currentseveritylevel", "type": "integer" }, "highestSeverityLevel": { "title": "Highestseveritylevel", "type": "integer" }, "mostRecentSetOccurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Mostrecentsetoccurredat" }, "mostRecentTransitionOccurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Mostrecenttransitionoccurredat" }, "channel": { "title": "Channel", "type": "string" }, "condition": { "title": "Condition", "type": "string" }, "displayName": { "title": "Displayname", "type": "string" }, "description": { "title": "Description", "type": "string" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "notes": { "items": {}, "title": "Notes", "type": "array" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Properties" }, "resourceType": { "title": "Resourcetype", "type": "string" } }, "$defs": { "AlarmTransition": { "description": "A transition within an instance, or occurrence, of an alarm.\n\nAlarm transitions record changes to an alarm's clear field as well as an alarm\nincreasing or decreasing in severity.", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType" }, "occurredAt": { "format": "date-time", "title": "Occurredat", "type": "string" }, "severityLevel": { "title": "Severitylevel", "type": "integer" }, "value": { "title": "Value", "type": "string" }, "condition": { "title": "Condition", "type": "string" }, "shortText": { "title": "Shorttext", "type": "string" }, "detailText": { "title": "Detailtext", "type": "string" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Properties" } }, "required": [ "transitionType", "occurredAt", "severityLevel", "value", "condition", "shortText", "detailText", "keywords", "properties" ], "title": "AlarmTransition", "type": "object" }, "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } }, "required": [ "instanceId", "alarmId", "workspace", "active", "clear", "acknowledged", "acknowledgedAt", "acknowledgedBy", "occurredAt", "updatedAt", "createdBy", "transitions", "transitionOverflowCount", "notificationStrategyIds", "currentSeverityLevel", "highestSeverityLevel", "mostRecentSetOccurredAt", "mostRecentTransitionOccurredAt", "channel", "condition", "displayName", "description", "keywords", "notes", "properties", "resourceType" ] }
- Fields
-
field acknowledged:
bool[Required] When set to true, the alarm has been acknowledged by an alarm handler, which is typically a human.
Alarms always begin life with acknowledged=False. Acknowledging an alarm will not affect the active flag unless clear is also true. When clear and acknowledged are true, the alarm will become inactive (active=False). This field is automatically reset to false when the alarm’s highestSeverityLevel field increases.
-
field acknowledged_at:
Optional[datetime] [Required] The date and time when the alarm instance was acknowledged.
This field will be cleared when the alarm’s highestSeverityLevel field increases.
-
field acknowledged_by:
Optional[str] [Required] The userId of the individual who acknowledged the alarm.
This field will be cleared when the alarm’s highestSeverityLevel field increases.
-
field active:
bool[Required] Whether or not the alarm is active.
An active alarm deserves human or automated attention. Alarms always begin life with active=True. This field will be automatically set to false when the clear and acknowledged fields are set to true.
-
field alarm_id:
str[Required] A value meant to uniquely identify the particular process or condition tracked by the alarm.
For example, alarms created by a tag rule engine might have their alarmIds set to the concatenation of the path of the tag which caused the rule to be triggered and the ID of the rule.
-
field channel:
str[Required] An identifier for the tag or resource associated with the alarm.
-
field clear:
bool[Required] When set to true, the condition that triggered the alarm no longer matches the trigger condition.
When an alarm is created, clear is initially set to false. The creator of the alarm (typically a rule engine or application element of some sort) may determine that the trigger condition no longer applies, and may send an update, clearing the alarm. Clearing the alarm does not deactivate the alarm, unless the alarm had previously been acknowledged. As long as the alarm is active=true, the alarm may transition from clear=True to clear=False (or vice versa) multiple times.
-
field condition:
str[Required] A description of the condition associated with the alarm.
-
field created_by:
str[Required] An identifier for who or what created the alarm.
This is usually used to identify the particular rule engine which requested that the alarm be created.
-
field current_severity_level:
int[Required] The current severity level of the alarm.
-
field description:
str[Required] Optional description text for the alarm.
-
field display_name:
str[Required] Optional display name for the alarm. Display names do not need to be unique.
-
field highest_severity_level:
int[Required] The highest severity level that the alarm has ever been in.
-
field instance_id:
str[Required] The unique identifier for the instance, or occurrence, of the alarm.
-
field keywords:
List[str] [Required] Words or phrases associated with the alarm.
Alarms can be tagged with keywords to make it easier to find them with queries.
-
field most_recent_set_occurred_at:
Optional[datetime] [Required] The date and time of the most recent occurrence of a SET transition.
This property only considers transitions that cause an alarm state change.
-
field most_recent_transition_occurred_at:
Optional[datetime] [Required] The date and time of the most recent occurrence of a transition.
This property only considers transitions that cause an alarm state change.
-
field notes:
List[Any] [Required] A collection of notes for a given alarm instance.
Notes are not currently supported and this will always be an empty list.
-
field notification_strategy_ids:
List[str] [Required] The IDs of the notification strategies which will be triggered.
These are triggered when the alarm is first created and when its highestSeverityLevel increases.
-
field occurred_at:
datetime[Required] The date and time when the alarm was created/first occurred.
-
field properties:
Dict[str,str] [Required] The alarm’s custom properties.
-
field resource_type:
str[Required] The type of resource associated with the alarm.
-
field transition_overflow_count:
int[Required] The number of transitions which overflowed the transitions field for the alarm.
For example, if the alarm transitioned 250 times, transitionOverflowCount is set to 150 and transitions contains the first and most recent 99 transitions. The configuration for the service determines the total number of stored transitions per alarm.
-
field transitions:
List[AlarmTransition] [Required] A collection of AlarmTransitions for the alarm.
The service stores the first transition and the most recent 99 other transitions by default. The configuration for the service determines the total number of stored transitions per alarm.
-
field updated_at:
datetime[Required] The date and time when the alarm was last updated or modified.
-
field workspace:
str[Required] The workspace the alarm belongs to.
- class nisystemlink.clients.alarm.models.AlarmOrderBy(value)[source]
The sort order of the returned list of alarms.
- UPDATED_AT = 'UPDATED_AT'
The date and time the alarm was last updated.
- class nisystemlink.clients.alarm.models.AlarmSeverityLevel(value)[source]
Well-known alarm severity levels.
The service supports custom severity levels greater than 4, but it is generally discouraged. The SystemLink Alarm UI only has display strings for severity levels in the range [1, 4].
- CLEAR = -1
Severity level for cleared alarms.
- CRITICAL = 4
Critical severity level.
- HIGH = 3
High severity level.
- LOW = 1
Low severity level.
- MODERATE = 2
Moderate severity level.
- pydantic model nisystemlink.clients.alarm.models.AlarmTransition[source]
A transition within an instance, or occurrence, of an alarm.
Alarm transitions record changes to an alarm’s clear field as well as an alarm increasing or decreasing in severity.
Show JSON schema
{ "title": "AlarmTransition", "description": "A transition within an instance, or occurrence, of an alarm.\n\nAlarm transitions record changes to an alarm's clear field as well as an alarm\nincreasing or decreasing in severity.", "type": "object", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType" }, "occurredAt": { "format": "date-time", "title": "Occurredat", "type": "string" }, "severityLevel": { "title": "Severitylevel", "type": "integer" }, "value": { "title": "Value", "type": "string" }, "condition": { "title": "Condition", "type": "string" }, "shortText": { "title": "Shorttext", "type": "string" }, "detailText": { "title": "Detailtext", "type": "string" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Properties" } }, "$defs": { "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } }, "required": [ "transitionType", "occurredAt", "severityLevel", "value", "condition", "shortText", "detailText", "keywords", "properties" ] }
- Fields
-
field condition:
str[Required] A description of the condition associated with the transition.
-
field detail_text:
str[Required] A detailed description of the condition.
-
field keywords:
List[str] [Required] Words or phrases associated with a transition.
Useful for attaching metadata to a transition which could aid in an investigation into an alarm’s root cause in the future.
-
field occurred_at:
datetime[Required] The date and time when the transition occurred.
-
field properties:
Dict[str,str] [Required] Key-value pair metadata associated with a transition.
Useful for attaching additional metadata to a transition which could aid in an investigation into an alarm’s root cause in the future. Property keys must be between 1 and 255 characters.
-
field severity_level:
int[Required] The severity of the transition.
Valid values for CLEAR transitions are [-1, -1]. Valid values for SET transitions are [1, 2147483647]. Note that the SystemLink Alarm UI only has display strings for SET severities in the range [1, 4]. The
AlarmSeverityLevelenum provides values for standard severity levels.
-
field short_text:
str[Required] A short description of the condition.
-
field transition_type:
AlarmTransitionType[Required] Specifies a type of alarm transition: CLEAR or SET.
-
field value:
str[Required] The value that caused the alarm to transition.
- class nisystemlink.clients.alarm.models.AlarmTransitionType(value)[source]
Specifies a type of alarm transition.
- CLEAR = 'CLEAR'
The transition corresponds to the clearing of the condition tracked by the alarm.
- SET = 'SET'
The transition corresponds to the condition tracked by the alarm entering into the triggered state.
- pydantic model nisystemlink.clients.alarm.models.ClearAlarmTransition[source]
Contains information about a CLEAR transition used to clear an instance of an alarm.
This is a convenience class that automatically sets transition_type to CLEAR and severity_level to -1 (CLEAR severity).
Show JSON schema
{ "title": "ClearAlarmTransition", "description": "Contains information about a CLEAR transition used to clear an instance of an alarm.\n\nThis is a convenience class that automatically sets transition_type to CLEAR\nand severity_level to -1 (CLEAR severity).", "type": "object", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType", "default": "CLEAR" }, "occurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Occurredat" }, "severityLevel": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": -1, "title": "Severitylevel" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "shortText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Shorttext" }, "detailText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Detailtext" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "$defs": { "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } } }
- Fields
- Validators
-
field severity_level:
Optional[int] = AlarmSeverityLevel.CLEAR The severity of the transition.
Valid values for CLEAR transitions are [-1, -1]. Valid values for SET transitions are [1, 2147483647]. Note that the SystemLink Alarm UI only has display strings for SET severities in the range [1, 4]. The
AlarmSeverityLevelenum provides values for standard severity levels.- Validated by
-
field transition_type:
AlarmTransitionType= AlarmTransitionType.CLEAR Specifies a type of alarm transition: CLEAR or SET.
- Validated by
- pydantic model nisystemlink.clients.alarm.models.CreateAlarmTransition[source]
Contains information about a transition used to create or update an instance of an alarm.
Show JSON schema
{ "title": "CreateAlarmTransition", "description": "Contains information about a transition used to create or update an instance of an alarm.", "type": "object", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType" }, "occurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Occurredat" }, "severityLevel": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 2, "title": "Severitylevel" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "shortText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Shorttext" }, "detailText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Detailtext" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "$defs": { "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } }, "required": [ "transitionType" ] }
- Fields
-
field condition:
Optional[str] = None A description of the condition associated with the transition.
-
field detail_text:
Optional[str] = None A detailed description of the condition.
-
field keywords:
Optional[List[str]] = None Words or phrases associated with a transition.
Useful for attaching metadata to a transition which could aid in an investigation into an alarm’s root cause in the future.
-
field occurred_at:
Optional[datetime] = None The date and time when the transition occurred.
-
field properties:
Optional[Dict[str,str]] = None Key-value pair metadata associated with a transition.
Useful for attaching additional metadata to a transition which could aid in an investigation into an alarm’s root cause in the future. Property keys must be between 1 and 255 characters. Property values can be up to 1000 characters.
-
field severity_level:
Optional[int] = 2 The severity of the transition.
Valid values for CLEAR transitions are [-1, -1]. Valid values for SET transitions are [1, 2147483647]. Note that the SystemLink Alarm UI only has display strings for SET severities in the range [1, 4]. The
AlarmSeverityLevelenum provides values for standard severity levels.
-
field short_text:
Optional[str] = None A short description of the condition.
-
field transition_type:
AlarmTransitionType[Required] Specifies a type of alarm transition: CLEAR or SET.
-
field value:
Optional[str] = None The value that caused the alarm to transition.
- pydantic model nisystemlink.clients.alarm.models.CreateOrUpdateAlarmRequest[source]
Contains information about the alarm to create or update.
If an alarm is being updated, only alarmId, workspace, and transition are applied.
Show JSON schema
{ "title": "CreateOrUpdateAlarmRequest", "description": "Contains information about the alarm to create or update.\n\nIf an alarm is being updated, only alarmId, workspace, and transition are applied.", "type": "object", "properties": { "alarmId": { "title": "Alarmid", "type": "string" }, "workspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Workspace" }, "transition": { "$ref": "#/$defs/CreateAlarmTransition" }, "notificationStrategyIds": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Notificationstrategyids" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Createdby" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Channel" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Displayname" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Description" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "$defs": { "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" }, "CreateAlarmTransition": { "description": "Contains information about a transition used to create or update an instance of an alarm.", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType" }, "occurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Occurredat" }, "severityLevel": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 2, "title": "Severitylevel" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "shortText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Shorttext" }, "detailText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Detailtext" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "required": [ "transitionType" ], "title": "CreateAlarmTransition", "type": "object" } }, "required": [ "alarmId", "transition" ] }
- Fields
-
field alarm_id:
str[Required] A value meant to uniquely identify the particular process or condition tracked by the alarm.
For example, alarms created by a tag rule engine might have their alarmIds set to the concatenation of the path of the tag which caused the rule to be triggered and the ID of the rule.
-
field channel:
Optional[str] = None An identifier for the tag or resource associated with the alarm.
-
field created_by:
Optional[str] = None An identifier for who or what created the alarm.
This is usually used to identify the particular rule engine which requested that the alarm be created.
-
field description:
Optional[str] = None Optional description text for the alarm.
-
field display_name:
Optional[str] = None Optional display name for the alarm. Display names do not need to be unique.
-
field keywords:
Optional[List[str]] = None Words or phrases associated with the alarm.
Alarms can be tagged with keywords to make it easier to find them with queries.
-
field notification_strategy_ids:
Optional[List[str]] = None The IDs of the notification strategies which should be triggered.
These are triggered if this request results in an alarm being created or transitioning to a new highest severity.
-
field properties:
Optional[Dict[str,str]] = None The alarm’s custom properties. Property keys must be between 1 and 255 characters. Property values can be up to 1000 characters.
-
field resource_type:
Optional[str] = None The type of resource associated with the alarm.
-
field transition:
CreateAlarmTransition[Required] Contains information about a transition used to create or update an instance of an alarm.
Consider using SetAlarmTransition to trigger an alarm or ClearAlarmTransition to clear an alarm. These convenience classes automatically set the appropriate transition type and severity level.
-
field workspace:
Optional[str] = None The ID of the workspace in which to create or update the alarm.
When not specified, the default workspace is used based on the requesting user.
- pydantic model nisystemlink.clients.alarm.models.DeleteAlarmsResponse[source]
Contains information about alarms that were deleted.
Show JSON schema
{ "title": "DeleteAlarmsResponse", "description": "Contains information about alarms that were deleted.", "type": "object", "properties": { "failed": { "items": { "type": "string" }, "title": "Failed", "type": "array" }, "error": { "anyOf": [ { "$ref": "#/$defs/ApiError" }, { "type": "null" } ], "default": null }, "deleted": { "items": { "type": "string" }, "title": "Deleted", "type": "array" } }, "$defs": { "ApiError": { "description": "Represents the standard error structure for SystemLink API responses.", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "args": { "default": [], "items": { "type": "string" }, "title": "Args", "type": "array" }, "resourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourcetype" }, "resourceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Resourceid" }, "innerErrors": { "default": [], "items": { "$ref": "#/$defs/ApiError" }, "title": "Innererrors", "type": "array" } }, "title": "ApiError", "type": "object" } }, "required": [ "failed", "deleted" ] }
- Fields
-
field deleted:
List[str] [Required] The instanceIds of the alarms that were successfully deleted.
- pydantic model nisystemlink.clients.alarm.models.QueryAlarmsWithFilterRequest[source]
Contains filter information for querying alarms.
Show JSON schema
{ "title": "QueryAlarmsWithFilterRequest", "description": "Contains filter information for querying alarms.", "type": "object", "properties": { "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filter" }, "substitutions": { "anyOf": [ { "items": { "anyOf": [ { "type": "boolean" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Substitutions" }, "returnMostRecentlyOccurredOnly": { "default": false, "title": "Returnmostrecentlyoccurredonly", "type": "boolean" }, "transitionInclusionOption": { "anyOf": [ { "$ref": "#/$defs/TransitionInclusionOption" }, { "type": "null" } ], "default": null }, "referenceTime": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Referencetime" }, "take": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 1000, "title": "Take" }, "orderBy": { "anyOf": [ { "$ref": "#/$defs/AlarmOrderBy" }, { "type": "null" } ], "default": null }, "orderByDescending": { "default": false, "title": "Orderbydescending", "type": "boolean" }, "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "returnCount": { "default": false, "title": "Returncount", "type": "boolean" } }, "$defs": { "AlarmOrderBy": { "description": "The sort order of the returned list of alarms.", "enum": [ "UPDATED_AT" ], "title": "AlarmOrderBy", "type": "string" }, "TransitionInclusionOption": { "description": "Determines which transitions to include in the query results.", "enum": [ "NONE", "MOST_RECENT_ONLY", "ALL" ], "title": "TransitionInclusionOption", "type": "string" } } }
- Fields
-
field continuation_token:
Optional[str] = None A token which allows the user to resume a query at the next item in the matching results.
When querying, a token will be returned if a query may be continued. To obtain the next page of results, pass the token to the service on a subsequent request.
-
field filter:
Optional[str] = None The alarm query filter in Dynamic LINQ format.
Allowed properties in the filter are:
acknowledged: Boolean value that indicates an alarm acknowledgmentacknowledgedAt: DateTime value that represents when the alarm was acknowledgedactive: Boolean value that indicates an active alarmalarmId: String value that identifies the process or condition tracked by the alarmchannel: String value that identifies the tag or resource associated with the alarmclear: Boolean value that indicates an alarm clearancecreatedBy: String value that identifies the user that created the alarmcurrentSeverityLevel: Int32 value that represents the severity level of the alarmdescription: String value that describes the alarmdisplayName: String value that represents the alarm name in the user interfacehighestSeverityLevel: Int32 value that represents the highest severity level of the alarmkeywords: List of string values associated with the alarmmostRecentSetOccurredAt: DateTime value that represents when the most recent set transition occurredmostRecentTransitionOccurredAt: DateTime value that represents when the most recent transition occurredoccurredAt: DateTime value that represents when the alarm was created or first occurredoccurredWithin: TimeSpan value that represents when the alarm was created or first occurredproperties: Dictionary that contains the string keys and values representing alarm metadataresourceType: String value that represents the resource type of the alarmworkspace: String ID of the workspace to use in the queryworkspaceName: String name of the workspace of the alarm
Allowed constants in the filter are:
RelativeTime.CurrentDay: TimeSpan representing the elapsed time between now and the start of the current dayRelativeTime.CurrentWeek: TimeSpan representing the elapsed time between now and the start of the current weekRelativeTime.CurrentMonth: TimeSpan representing the elapsed time between now and the start of the current monthRelativeTime.CurrentYear: TimeSpan representing the elapsed time between now and the start of the current year
-
field order_by:
Optional[AlarmOrderBy] = None The sort order of the returned list of alarms.
By default, alarms are sorted in ascending order based on the specified value.
-
field order_by_descending:
bool= False Whether to sort descending instead of ascending.
The elements in the list are sorted ascending by default. If true, sorts descending.
-
field reference_time:
Optional[datetime] = None The date and time to use as the reference point for RelativeTime filters.
Includes time zone information. Defaults to the current time in UTC.
-
field return_count:
bool= False Whether to return the total number of alarms that match the provided filter.
This disregards the take value.
-
field return_most_recently_occurred_only:
bool= False Whether or not the Alarm Service should group the alarms matched by this query by alarmId.
When true, only return the most recent alarm for each grouping. In this context, recency is based on when the alarm occurred, not when it was last updated.
-
field substitutions:
Optional[List[UnionType[bool,int,str,None]]] = None Makes substitutions in the query filter expression.
Substitutions for the query expression are indicated by non-negative integers that are prefixed with the @ symbol. Each substitution in the given expression will be replaced by the element at the corresponding index (zero-based) in this list.
-
field take:
Optional[int] = 1000 Limits the returned list to the specified number of results. Maximum is 1000.
-
field transition_inclusion_option:
Optional[TransitionInclusionOption] = None Determines which transitions to include in the query results, if any.
- pydantic model nisystemlink.clients.alarm.models.QueryAlarmsWithFilterResponse[source]
Contains information about the alarms matched by a query.
Show JSON schema
{ "title": "QueryAlarmsWithFilterResponse", "description": "Contains information about the alarms matched by a query.", "type": "object", "properties": { "continuationToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Continuationtoken" }, "alarms": { "items": { "$ref": "#/$defs/Alarm" }, "title": "Alarms", "type": "array" }, "totalCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Totalcount" } }, "$defs": { "Alarm": { "description": "An individual instance, or occurrence, of an alarm.\n\nThe lifecycle of an alarm begins the first time it is triggered and ends when it has been\nboth acknowledged and cleared. The service enforces the invariant that there can be at most\none active=True alarm with the same alarmId.", "properties": { "instanceId": { "title": "Instanceid", "type": "string" }, "alarmId": { "title": "Alarmid", "type": "string" }, "workspace": { "title": "Workspace", "type": "string" }, "active": { "title": "Active", "type": "boolean" }, "clear": { "title": "Clear", "type": "boolean" }, "acknowledged": { "title": "Acknowledged", "type": "boolean" }, "acknowledgedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Acknowledgedat" }, "acknowledgedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acknowledgedby" }, "occurredAt": { "format": "date-time", "title": "Occurredat", "type": "string" }, "updatedAt": { "format": "date-time", "title": "Updatedat", "type": "string" }, "createdBy": { "title": "Createdby", "type": "string" }, "transitions": { "items": { "$ref": "#/$defs/AlarmTransition" }, "title": "Transitions", "type": "array" }, "transitionOverflowCount": { "title": "Transitionoverflowcount", "type": "integer" }, "notificationStrategyIds": { "items": { "type": "string" }, "title": "Notificationstrategyids", "type": "array" }, "currentSeverityLevel": { "title": "Currentseveritylevel", "type": "integer" }, "highestSeverityLevel": { "title": "Highestseveritylevel", "type": "integer" }, "mostRecentSetOccurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Mostrecentsetoccurredat" }, "mostRecentTransitionOccurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Mostrecenttransitionoccurredat" }, "channel": { "title": "Channel", "type": "string" }, "condition": { "title": "Condition", "type": "string" }, "displayName": { "title": "Displayname", "type": "string" }, "description": { "title": "Description", "type": "string" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "notes": { "items": {}, "title": "Notes", "type": "array" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Properties" }, "resourceType": { "title": "Resourcetype", "type": "string" } }, "required": [ "instanceId", "alarmId", "workspace", "active", "clear", "acknowledged", "acknowledgedAt", "acknowledgedBy", "occurredAt", "updatedAt", "createdBy", "transitions", "transitionOverflowCount", "notificationStrategyIds", "currentSeverityLevel", "highestSeverityLevel", "mostRecentSetOccurredAt", "mostRecentTransitionOccurredAt", "channel", "condition", "displayName", "description", "keywords", "notes", "properties", "resourceType" ], "title": "Alarm", "type": "object" }, "AlarmTransition": { "description": "A transition within an instance, or occurrence, of an alarm.\n\nAlarm transitions record changes to an alarm's clear field as well as an alarm\nincreasing or decreasing in severity.", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType" }, "occurredAt": { "format": "date-time", "title": "Occurredat", "type": "string" }, "severityLevel": { "title": "Severitylevel", "type": "integer" }, "value": { "title": "Value", "type": "string" }, "condition": { "title": "Condition", "type": "string" }, "shortText": { "title": "Shorttext", "type": "string" }, "detailText": { "title": "Detailtext", "type": "string" }, "keywords": { "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Properties" } }, "required": [ "transitionType", "occurredAt", "severityLevel", "value", "condition", "shortText", "detailText", "keywords", "properties" ], "title": "AlarmTransition", "type": "object" }, "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } }, "required": [ "alarms" ] }
- Fields
-
field total_count:
Optional[int] = None The total number of alarms which matched the query, if requested.
- pydantic model nisystemlink.clients.alarm.models.SetAlarmTransition[source]
Contains information about a SET transition used to create or update an instance of an alarm.
This is a convenience class that automatically sets transition_type to SET.
Show JSON schema
{ "title": "SetAlarmTransition", "description": "Contains information about a SET transition used to create or update an instance of an alarm.\n\nThis is a convenience class that automatically sets transition_type to SET.", "type": "object", "properties": { "transitionType": { "$ref": "#/$defs/AlarmTransitionType", "default": "SET" }, "occurredAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Occurredat" }, "severityLevel": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 2, "title": "Severitylevel" }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Value" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "shortText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Shorttext" }, "detailText": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Detailtext" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Keywords" }, "properties": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Properties" } }, "$defs": { "AlarmTransitionType": { "description": "Specifies a type of alarm transition.", "enum": [ "CLEAR", "SET" ], "title": "AlarmTransitionType", "type": "string" } } }
- Fields
- Validators
-
field transition_type:
AlarmTransitionType= AlarmTransitionType.SET Specifies a type of alarm transition: CLEAR or SET.
- Validated by
- class nisystemlink.clients.alarm.models.TransitionInclusionOption(value)[source]
Determines which transitions to include in the query results.
- ALL = 'ALL'
All transitions are included.
- MOST_RECENT_ONLY = 'MOST_RECENT_ONLY'
The most recent transition is included.
- NONE = 'NONE'
No transitions are included.