Version: 1.2.0

Retrieve an alarm

GET /alarm/:alarmId

Retrieve an alarm

Request

Path Parameters

alarmId int64required

Header Parameters

Authorization string

X-Forwarded-Proto string

X-Forwarded-Host string

Responses

default

default response

application/json

Schema
Example (from schema)

Schema

id int64

realm stringrequired

title string

content string

severity stringrequired

Possible values: [LOW, MEDIUM, HIGH]

status stringrequired

Possible values: [OPEN, ACKNOWLEDGED, IN_PROGRESS, RESOLVED, CLOSED]

source stringrequired

Possible values: [MANUAL, CLIENT, GLOBAL_RULESET, REALM_RULESET, ASSET_RULESET, AGENT]

sourceId string

sourceUsername string

createdOn date-time

acknowledgedOn date-time

lastModified date-time

assigneeId string

assigneeUsername string

asset

object[]

Array [

id string

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

version int64

createdOn date-time

name stringrequired

Possible values: non-empty and <= 1023 characters

accessPublicRead boolean

parentId string

Possible values: Value must match regular expression ^[0-9A-Za-z]{22}$

realm stringrequired

Possible values: non-empty and <= 255 characters

type string

path string[]

attributes

object

delegate

object

property name*

AttributeObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

timestamp int64

property name*

AttributeObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

meta

object

delegate

object

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

property name*

MetaItemObject

type

object

name string

Possible values: Value must match regular expression ^\w+(\[\])?$

constraints

object[]

Array [

message string

type stringrequired

]

format

object

useGrouping boolean

minimumIntegerDigits int32

minimumFractionDigits int32

maximumFractionDigits int32

minimumSignificantDigits int32

maximumSignificantDigits int32

asBoolean boolean

asDate boolean

asSlider boolean

resolution number

dateStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStyle string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriod string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12 boolean

iso8601 boolean

weekday string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

era string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

year string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

month string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

week string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

day string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

minute string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

second string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigits int32

timeZoneName string

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormat string

asNumber boolean

asOnOff boolean

asPressedReleased boolean

asOpenClosed boolean

asMomentary boolean

multiline boolean

units string[]

arrayDimensions int32

metaUseOnly boolean

jsonType string

name stringrequired

Possible values: Value must match regular expression ^\w+$

timestamp int64

]

{
  "id": 0,
  "realm": "string",
  "title": "string",
  "content": "string",
  "severity": "LOW",
  "status": "OPEN",
  "source": "MANUAL",
  "sourceId": "string",
  "sourceUsername": "string",
  "createdOn": "2024-07-29T15:51:28.071Z",
  "acknowledgedOn": "2024-07-29T15:51:28.071Z",
  "lastModified": "2024-07-29T15:51:28.071Z",
  "assigneeId": "string",
  "assigneeUsername": "string",
  "asset": [
    {
      "id": "string",
      "version": 0,
      "createdOn": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "accessPublicRead": true,
      "parentId": "string",
      "realm": "string",
      "type": "string",
      "path": [
        "string"
      ],
      "attributes": {
        "delegate": {}
      }
    }
  ]
}

Retrieve an alarm

/alarm/:alarmId

Request​

Path Parameters

Header Parameters

Responses​

Request

Responses