AlarmActionInfo

A base class for Alarm ActionsAlarm actions are executed in response to specific events, as defined by the Alarm Definition. One alarm Definition may have many alarm actions, and one alarm action may be used by many different Alarm Definitions

This is what to do if there is an alarm according to the Alarm Definition.

AlarmActionInfo Properties

Item -> BaseInfo -> AlarmActionInfo

AlarmActionInfo -> AwsAlarmActionInfo -> ExecuteProcedureActionInfo -> NotificationActionInfo -> WebHookInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
CommonName String BaseInfo Common Name of the resource.The common name of the resource.
InFolderHref String BaseInfo relative path Href value for the containing folderAll objects exist within a folder. Even folders!
InFolderKey String BaseInfo Represents the internal ID of the containing folder
IsGlobal Boolean BaseInfo If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects.
Key String BaseInfo Represents the internal ID of the object.
Links List<Link> BaseInfo List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required.
Metadata MetadataItem[] BaseInfo The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data.
Monikers MonikerItem[] BaseInfo the set of Monikers for this object
Notes NoteInfo[] BaseInfo The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted.
ObjectLinks ObjectLinkItem[] BaseInfo The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set.
Tags String[] BaseInfo the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights
GracePeriod Nullable<TimeSpan> AlarmActionInfo Gets or sets the allowable TimeSpan between the time the event OccurredOn and the time the alarm action is being processed.
IsEnabled Boolean AlarmActionInfo Gets or sets a value indicating whether this alarm action is enabled.Possible Values (true, false)
Logged Boolean AlarmActionInfo Gets or sets a value indicating whether this AlarmActionInfo is logged.Logging of Alarm actions is on the Event itself as comments in the Alarm Acknowlegements collection.Possible Values (true, false)

JSON Structure of AlarmActionInfo

{
   "Href"	:	"String",
   "CommonName"	:	"String",
   "InFolderHref"	:	"String",
   "InFolderKey"	:	"String",
   "IsGlobal"	:	"Boolean",
   "Key"	:	"String",
   "Links"	:	"List\<[Link](/object-model/link)\>",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)[]",
   "Monikers"	:	"[MonikerItem](/object-model/monikeritem)[]",
   "Notes"	:	"[NoteInfo](/object-model/noteinfo)[]",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "Tags"	:	"String[]",
   "GracePeriod"	:	"Nullable\<TimeSpan\>",
   "IsEnabled"	:	"Boolean",
   "Logged"	:	"Boolean"
}

Add Alarm Action Async

Example in C#

// Returns: AlarmActionInfo
var alarmActionInfo = await client.AddAlarmActionAsync(FolderInfo folder, AlarmActionInfo alarmAction)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmactions \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                   "$type":"Feenics.Keep.WebApi.Model.AlarmActionInfo, Feenics.Keep.WebApi.Model",
                   "IsEnabled":false,
                   "Logged":false,
                   "GracePeriod":null,
                   "Key":null,
                   "CommonName":null,
                   "InFolderHref":null,
                   "InFolderKey":null,
                   "Links":[],
                   "ObjectLinks":null,
                   "Metadata":null,
                   "Notes":null,
                   "Tags":null,
                   "Monikers":null,
                   "Href":null
               }'
            

Add Alarm Action To Alarm Definition Async

Example in C#

// Returns: nothing
await client.AddAlarmActionToAlarmDefinitionAsync(AlarmDefinitionInfo alarmDefinition, AlarmActionInfo alarmAction)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmdefinitions/ALARMDEFINITION.KEY/collections/alarmactions \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
               -H 'Content-Type: application/json' \
               -d '"/api/f/INSTANCE.KEY/alarmactions/ALARMACTION.KEY"'
            

Delete Alarm Action Async

Example in C#

// Returns: nothing
await client.DeleteAlarmActionAsync(AlarmActionInfo alarmAction)

Example in CURL



           curl -X DELETE \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmactions/ALARMACTION.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Alarm Actions Async

Example in C#

// Returns: IEnumerable<AlarmActionInfo>
var alarmActionInfo = await client.GetAlarmActionsAsync(FolderInfo folder)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmactions \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Get Alarm Defintion Alarm Actions Async

Example in C#

// Returns: IEnumerable<AlarmActionInfo>
var alarmActionInfo = await client.GetAlarmDefintionAlarmActionsAsync(AlarmDefinitionInfo alarmDefinition)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmdefinitions/ALARMDEFINITION.KEY/collections/alarmactions \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Remove Alarm Action From Alarm Definition Async

Example in C#

// Returns: nothing
await client.RemoveAlarmActionFromAlarmDefinitionAsync(AlarmDefinitionInfo alarmDefinition, AlarmActionInfo alarmAction)

Example in CURL



           curl -X DELETE \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmdefinitions/ALARMDEFINITION.KEY/collections/alarmactions/ALARMACTION.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Update Alarm Action Async

Example in C#

// Returns: nothing
await client.UpdateAlarmActionAsync(AlarmActionInfo alarmAction)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/alarmactions/ALARMACTION.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.AlarmActionInfo, Feenics.Keep.WebApi.Model",
                       "IsEnabled":false,
                       "Logged":false,
                       "GracePeriod":null,
                       "Key":"ALARMACTION.KEY",
                       "CommonName":null,
                       "InFolderHref":"/api/f/INSTANCE.KEY",
                       "InFolderKey":"INSTANCE.KEY",
                       "Links":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Meta",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"meta",
                                   "Text":"Metadata"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Monikers",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"monikers",
                                   "Text":"Monikers"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"CommonName",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"commonname",
                                   "Text":"Common Name"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Images",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"images",
                                   "Text":"Images"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"TakeOwnership",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"takeownership",
                                   "Text":"Take Ownership"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Connections",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"connections",
                                   "Text":"Connected Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"References",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"references",
                                   "Text":"Referencing Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Notes",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"notes",
                                   "Text":"Notes"
                               }
                           }
                       ],
                       "ObjectLinks":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InInstance",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InstanceScope",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           }
                       ],
                       "Metadata":[],
                       "Notes":[],
                       "Tags":[],
                       "Monikers":[],
                       "Href":"/api/f/INSTANCE.KEY/alarmactions/ALARMACTION.KEY"
                   }'