Skip to main content
Get Status Monitor

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

Id

GetStatusMonitor: Get a single status monitor based on its identity

Id
integer<int32>

Response

OK

Definition of all properties for a status monitor Carrier object for StatusMonitor. Services for the StatusMonitor Carrier is available from the Saint Agent.

OwnerTable
integer<int32>

Id of table that owns the status monitor

Rank
integer<int32>

Priority rank, in case more than one status is signalled. Lowest wins

DefaultTask
integer<int32>

"Default task type for this status; the default task text is in the text table (since it can be long), and may contain template variables"

DefaultTaskText
string

Default task text for this status

IsVisual
boolean

Should the status be visualized (active) in the client

LastGenerated
string<date-time>

When was this status last generated (i.e., statusValue rows created)

Description
string

Description of the status monitor

Name
string

Name of status monitor

StatusMonitorId
integer<int32>

Primary key

PictureId
integer<int32>

Id of BinaryObject row that contains image for status monitor

NeedsUpdate
boolean

Is the definition dirty, ie., ALL values are invalid until a recalculation; this flag is set when the status DEFINITION is changed, as opposed to the flag on StatusValue

Deleted
boolean

Deleted flag, 1 if this record is deleted (never from the database)

NumMatches
integer<int32>

Number of targets that have this status, this should be the number of rows in StatusValue pointing to this definition, and that have isSignalled set to 1

NumNeedUpdate
integer<int32>

Number of targets that had this status, but have their needsUpdate bit set due to some change

GenerationStart
string<date-time>

When was the last regeneration started

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.