WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /situation/alerts?{parameters}
Name | Value Type | Description |
---|---|---|
locale | string |
The locale. This value consists of lowercase ISO language code (ISO 639) and the uppercase
ISO country code (ISO 3166) joined by an underscore (for example, en_US).
Results will be returned in the locale specified. If no locale is specified,
the locale of the REST server will be used.
|
page | int |
Which page to return, where -1 will mean return all.
|
pagesize | int |
Indicates the size of the pages requested. (will be ignored if not 1 or larger).
|
The default content-type is application/json.
The HTTP request can have a payload which contains parameters. The following table lists all input parameters that can be sent in the HTTP payload in JSON format.
Parameter Name |
Type |
Description |
FilterField |
string |
This property is the field that should be used. Valid values are
"KPI", "Owner", "Model", "Version",
"Modeled". KPI: this field type will filter on the KPI ID in the
condition(s) (only for dynamic
situations) Owner: this field type will filter on the user ID (only for dynamic situations) Model: this field type will filter on the monitoring model
ID (only for dynamic situations) Version: this field type will filter on the version ID of the
Monitoring Model (only for dynamic situations) Modeled: this field type will filter on how the Alert was
created, Modeled alert definitions are created in the Admin console based on
events from the generated model, Non Modeled definitions are alert
definitions created dynamically. |
Filter Operator |
array |
The filter operator. Valid values are: When FilterField is 'KPI', the valid operators are:equals,
notEquals, in, notIn, like, notLike When FilterField is 'Owner', the valid operators are:equals,
notEquals, in, notIn, like, notLike When FilterField is 'Model', the valid operators are:equals,
notEquals, in, notIn, like, notLike When FilterField is 'Version', the valid operators are: equals,
notEquals, in, notIn, lessThan, lessThanOrEquals, greaterThan,
greaterThanOrEquals When FilterField is 'Modeled', the valid operators are: isNull,
isNotNull Note: 'like' and 'notLike' will match the Filter Value string to
any part of the FilterField. For example ["i"] will match owner
userid 'admin' and 'myid'. |
Filter Value |
array |
The filter value, represented in a string format. The filter
value must be specified as an array. For example, a single string would be
represented as ["Smith"]. A list of values included with the 'in' operator would be
represented as ["Smith", "Jones"]. When FilterField is 'KPI', the valid Filter Value is any string
array, when filtering on equals the value string must be the full KPI name,
for example ["/My_Model/My_KPI"] When FilterField is 'Owner', the valid Filter Value is any
string array, this string will be the userid of the owner. When FilterField is 'Model', the valid Filter Value is any
string array when filtering on equals the value string must be the full Model
name, for example ["/My_Model"] When FilterField is 'Version', the valid Filter Value is any
single number as string text array, For example
["20081010121015444"] When FilterField is 'Modeled', no filter value is required. |
Case Sensitive |
boolean |
Indicates if the filter operator is case-sensitive. Valid values
are true and false. When the FilerField is 'Modeled' the Case Sensitive will be
ignored since character data is not being compared (only the origin of the data
is being compared) |
{ "type":["object"], "description": "An array of filter items to limit the number of situations returned", "items" : { "properties" : { "FilterField": { "type":"string", "optional": false, "enum":["KPI", "Owner", "Model", "Version", "Modeled"]}, "description": "This property is the field that should be used. KPI : this field type will filter on the KPI ID in the condition(s) (only for dynamic situations) Owner : this field type will filter on the user ID (only for dynamic situations) Model : this field type will filter on the monitoring model ID (only for dynamic situations) Version : this field type will filter on the version ID of the Monitoring Model (only for dynamic situations) Modeled : this field type will filter on how the Alert was created, Modeled alert definitions are created in the Admin console based on events from the generated model, Non Modeled definitions are alert definitions created dynamically.", }, "Filter Operator": { "type":"string", "optional": false, "description": "The filter operator. Valid values are: when FilterField is 'KPI' the valid operators are :equals, notEquals, in, notIn, like, notLike when FilterField is 'Owner' the valid operators are :equals, notEquals, in, notIn, like, notLike when FilterField is 'Model' the valid operators are :equals, notEquals, in, notIn, like, notLike when FilterField is 'Version' the valid operators are : equals, notEquals, in, notIn, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals when FilterField is 'Modeled' the valid operators are: isNull, isNotNull note: 'like' and 'notLike' will match the Filter Value string to any part of the FilterField for example ["i"] will match owner userid 'admin' and 'myid'. ", "enum": ["equals", "notEquals", "in", "notIn", "like", "notLike", "lessThan", "lessThanOrEquals", "greaterThan", "greaterThanOrEquals"] }, "Filter Value": { "type":["string"], "optional": true, "description": "The filter value, represented in a string format. The filter value must be specified as an array. For example, a single string would be represented as ["Smith"]. A list of values included with the 'in' operator would be represented as ["Smith", "Jones"]. when FilterField is 'KPI' the valid Filter Value is any string array, when filtering on equals the value string must be the full KPI name, for example ["/My_Model/My_KPI"] when FilterField is 'Owner' the valid Filter Value is any string array, this string will be the userid of the owner. when FilterField is 'Model' the valid Filter Value is any string array when filtering on equals the value string must be the full Model name, for example ["/My_Model"] when FilterField is 'Version' the valid Filter Value is any single number as string text array, for example ["20081010121015444"] when FilterField is 'Modeled', no filter value is requried." }, "Case Sensitive": { "type":"boolean", "optional": true, "default":true, "description": "Indicates if the filter operator is case-sensitive. Valid values are true and false. when the FilerField is 'Modeled' the Case Sensitive will be ignored since character data is not being compared (only the origin of the data is being compared)" } } } }
Example content:
-- the following sample finds all Dynamic Alerts that have conditions using KPI01 in the model My_model [{"FilterField":"KPI","Filter Operator":"equals","Filter Value":["/My_model/KPI01"],"Case Sensitive":true}] -- the following sample finds all Dynamic Alerts [{"FilterField":"Modeled","Filter Operator":"isNotNull"] -- the following sample finds all Alerts that were created by user admin [{"FilterField":"Owner","Filter Operator":"equals","Filter Value":["admin"],"Case Sensitive":false}] -- the following sample finds all Alerts for the model My_model and version 20080817101010333 [ {"FilterField":"Model","Filter Operator":"equals","Filter Value":["My_model"],"Case Sensitive":false}, {"FilterField":"Version","Filter Operator":"equals","Filter Value":["20080817101010333"],"Case Sensitive":false} ] -- the following sample finds all Alerts that have an owner userid that contains the letter "a", case sensitivity will default to false [{"FilterField":"Owner","Filter Operator":"like", "Filter Value":["a"]}]
The default content-type is application/json.
The following table lists all parameters in the JSON output:
Parameter Name |
Type |
Description |
||
Record Count |
number |
The number of records that matched this request. This will also
be the total returned if not using paging. |
||
|
number |
The maximum number of records on each page when using paging
(default is 10). |
||
|
number |
The page number requested. Use -1 when not using paging and
requesting all records. |
||
|
array |
An array of business situations. The array items will contain an
overview of each situation |
||
|
ID |
string |
The ID based on the name of this Dynamic Alert. |
|
|
Modeled |
boolean |
Indicates if this alert was created in the WAS admin console or
from business space. This is also an indication if this alert's configuration
may be altered using REST services |
|
|
Permission |
string |
The access allowed by the caller to this alert definition,
options are: FULL: Indicates that the caller has full access to this
definition allowing updates and subscriptions. READONLY: Indicates that the caller has only view access and
allowed to subscribe to this alert. |
|
|
Model ID |
string |
The model ID this alert is based on. |
|
|
Version |
string |
The version of the model this alert is based on. |
|
|
|
string |
The display name given by the user. |
|
|
User ID |
string |
The owner of this situation. Only users with KPI-Administrator
will be allowed to create situations with an owner other then themselves. |
|
|
|
string |
The state of this situation. Possible states are: inactive,
active, invalid |
|
|
|
string |
The display description given by the user. |
|
|
|
boolean |
Indicates if the body and subject were system generated, Default
is false. |
|
|
|
number |
Indicates the control access to view and subscriptions to this
alert. 0 = private 1
= public, Default is private |
|
|
|
string |
Describes the base timing interval, options are: MINUTE: indicates that minutes are the base timing amount HOUR: indicates that hours are the base timing amount DAY; indicates that days are the base timing amount WEEK: indicates that weeks are the base timing amount MONTH: indicates that months are the base timing amount PERIOD: indicates that the KPI period will be used |
|
|
|
string |
Describes a start time for the very first evaluation, the
evaluation will take place on the next evaluation cycle on or after the start
time, Optional, will use the current time. The time will also describe an
offset into the period type for the evaluation time. When TimingInterval MINUTE: intervals
will be calculated starting at the specified minutes after the top of the
hour. When TimingInterval HOUR: intervals
will be calculated starting at the specified hours and minutes after When TimingInterval DAY: will be the
time of day in the TimingTimeZone property to
evaluate the conditions. When TimingInterval WEEK: will be the time
of day and the day of the week in the TimingTimeZone
property to evaluate the conditions. When TimingInterval MONTH: will be the time of day and the day of
the month in the TimingTimeZone property to
evaluate the conditions. When TimingInterval PERIOD: does not
offset the evaluation time, the end of period time must be honored |
|
|
|
number |
Describes a multiple of the base timing interval, optional will
default to one. When TimingInterval MINUTE: the number
of minutes in the interval. (only allow even factors of the hour, 1, 2,3, 4,
5, 6, 10, 12, 15, 20 ,30 ) When TimingInterval HOUR: the number
of hours in the interval (only allow even factors of the day, 1, 2, 3, 4, 6,
8, 12 ) When TimingInterval DAY: the number of
days in the interval (allow 1 to 365). When TimingInterval WEEK: the number
of weeks in the interval (allow
up to 52) When TimingInterval MONTH: the number
of months (allow up to 12). When TimingInterval PERIOD: TimingMultiple property is not used. |
|
|
|
string |
When the conditions will be allowed to send an alert. REPEATING
= whenever the condition evaluates to true NONREPEATING = when the condition evaluates to true and not
again until the condition evaluates to false ONCEINPERIOD = when the condition evaluates to true and not
again until the next KPI period |
|
|
|
string |
Describes the ID of the KPI to use for the period time
evaluations, required when TimingRepeat=ONCEINPERIOD
and TimingInterval=PERIOD. |
|
|
|
string |
Describes the Timezone to use in
calculating the actual start time and next evaluation times, must use the
JAVA based time zone strings,
Optional, will use the server time zone. |
|
|
|
string |
The TimingStartOffset timestamp in the
localized formatted form. |
|
|
|
number |
Indicates the alert conditions have been evaluated to true when
set to 1. Indicates the alert conditions have been evaluated to false when
set to 0. |
|
|
|
string |
Describes the create time of this alert definition. The time
format is yyyy-mm-ddThh:mm:ss |
|
|
|
string |
Describes the create time of this alert definition. The time will
be in the localized formatted form. |
|
|
|
string |
The alert format is E-mail |
|
|
|
boolean |
The alert format is Dashboard |
|
|
|
boolean |
The alert format is Pager |
|
|
Cell |
boolean |
The alert format is Cell |
|
|
Warnings |
array |
An optional list of warning messages which will be included when
the situation is in the "invalid" state. |
|
|
|
Warning |
string |
The warning message |
{ "description":"Dynamic Alert List details", "type": "object", "properties": { "Record Count":{"type":"number", "optional": false, "description": "The number of records that matched this request. This will also be the total returned if not using paging."}, "Page Size":{"type":"number", "optional": false, "description": "The maximum number of records on each page when using paging (default is 10)."}, "Page Number":{"type":"number", "optional": false, "description": "The page number requested. Use -1 when not using paging and requesting all records."}, "BusinessSituationsArray": { "type":"array", "optional": false, "description":"An array of business situations. The array items will contain an overview of each situation", "items" : { "properties" : { "ID":{"type":"string", "optional": false, "description": "The ID based on the name of this Dynamic Alert."}, "Modeled":{"type":"boolean", "optional": false, "description": "Indicates if this alert was created in the WAS admin console or from business space. This is also an indication if this alert's configuration may be altered using REST services"}, "Permission":{"type":"string", "optional": true, "description": "The access allowed by the caller to this alert definition, options are: FULL: Indicates that the caller has full access to this definition allowing updates and subscriptions. READONLY: Indicates that the caller has only view access and allowed to subscribe to this alert.", "enum":["FULL", "READONLY"] }, "Model ID":{"type":"string", "optional": false, "description": "The model this alert is based on."}, "Version":{"type":"string", "optional": false, "description": "The version of the model this alert is based on."}, "Name":{"type":"string", "optional": false, "description": "The display name given by the user."}, "User ID":{"type":"string", "optional":true, "description":" The owner of this situation. Only users with KPI-Administrator will be allowed to create situations with an owner other then themselves."}, "State":{"type":"string", "optional":true, "description":" The state of this situation. Possible states are: inactive, active, invalid", "enum":["inactive", "actve", "invalid"] }, "Description":{"type":"string", "optional": false, "description": "The display description given by the user."} "GeneratedContent":{"type":"boolean", "optional":true, "description":"Indicates if the body and subject were system generated, default is false."}, "View Access":{"type":"number", "optional": true, "description": "Indictes the control access to view and subscriptions to this alert. 0 = private 1 = public, Default is private", "enum":[0, 1] }, "TimingInterval": {"type":"string", "optional": false, "description": "Describes the base timing interval, options are: MINUTE: indicates that minutes are the base timing amount HOUR: indicates that hours are the base timing amount DAY; indicates that days are the base timing amount WEEK: indicates that weeks are the base timing amount MONTH: indicates that months are the base timing amount PERIOD: indicates that the KPI period will be used ", "enum":["MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "PERIOD"] }, "TimingStartOffset": {"type":"string", "optional": true, "description": "Describes a start time for the very first evaluation, the evaluation will take place on the next evaluation cycle on or after the start time. This setting was Optional, so the system may have used the current time. The time will also describe an offset into the period type for the evaluation time. When TimingInterval MINUTE: intervals will be calculated starting at the specified minutes after the top of the hour. When TimingInterval HOUR: intervals will be calculated starting at the specified hours and minutes after midnight in the TimingTimeZone property. When TimingInterval DAY: will be the time of day in the TimingTimeZone property to evaluate the conditions. When TimingInterval WEEK: will be the time of day and the day of the week in the TimingTimeZone property to evaluate the conditions. When TimingInterval MONTH: will be the time of day and the day of the month in the TimingTimeZone property to evaluate the conditions. When TimingInterval PERIOD: does not offset the evaluation time, the end of period time must be honored "}, "TimingMultiple": {"type":"number", "optional": true, "description": "Describes a multiple of the base timing interval, optional will default to one. When TimingInterval MINUTE: the number of minutes in the interval. (only allow even factors of the hour, 1, 2,3, 4, 5, 6, 10, 12, 15, 20 ,30 ) When TimingInterval HOUR: the number of hours in the interval (only allow even factors of the day, 1, 2, 3, 4, 6, 8, 12 ) When TimingInterval DAY: the number of days in the interval (allow 1 to 365). When TimingInterval WEEK: the number of weeks in the interval (allow up to 52) When TimingInterval MONTH: the number of months (allow up to 12). When TimingInterval PERIOD: TimingMultiple property is not used. "}, "TimingRepeat": {"type":"string", "optional": false, "description": "When the conditions will be allowed to send an alert. REPEATING = whenever the condition evaluates to true NONREPEATING = when the condition evaluates to true and not again until the condition evaluates to false ONCEINPERIOD = when the condition evaluates to true and not again until the next KPI period ", "enum":["REPEATING", "NONREPEATING", "ONCEINPERIOD"] }, "TimingKPI": {"type":"string", "optional": true, "description": "Describes the ID of the KPI to use for the period time evaluations, required when TimingRepeat=ONCEINPERIOD and TimingInterval=PERIOD,"}, "TimingTimeZone": {"type":"string", "optional": true, "description": "Describes the Timezone to use in calculating the actual start time and next evaluation times, must use the JAVA based time zone strings, Optional, will use the server time zone."}, "TimingStartOffsetLocalized": {"type":"string", "optional": true, "description": "The TimingStartOffset timestamp in the localized formatted form."}, "SituationTriggered": {"type":"number", "optional": true, "description": "Indicates the alert conditions have been evaluated to true when set to 1. Indicates the alert conditions have been evaluated to false when set to 0.", "enum":[0, 1] }, "Creation Timestamp": {"type":"string", "optional": true, "description": "Describes the create time of this alert definition. The time format is yyyy-mm-ddThh:mm:ss"}, "Creation Timestamp Localized": {"type":"string", "optional": true, "description": "Describes the create time of this alert definition. The time will be in the localized formatted form."}, "E-mail": {"type":"boolean", "optional": true, "description": "The alert format is E-mail (true if the owner has as e-mail subscription to this alert)"}, "Dashboard": {"type":"boolean", "optional": true, "description": "The alert format is Dashboard (true if the owner has as dashboard alert subscription to this alert)"}, "Cell": {"type":"boolean", "optional": true, "description": "The alert format is Cell (true if the owner has as cell subscription to this alert)"}, "Pager": {"type":"boolean", "optional": true, "description": "The alert format is Pager (true if the owner has as pager subscription to this alert)"}, "Warnings":{ "type":"array", "optional":true, "description": "An optional list of warning messages which will be included when the situation is in the "invalid" state." "items" : {"properties": {"Warning":{"type":"string"}}} } } } } } }
Example content:
{ "Record Count":2, "BusinessSituationArray": [ { "Creation Timestamp Localized":"December 3,2008 12:58:58 PM", "TimingMultiple":1, "SituationTriggered":0, "TimingRepeat":"REPEATING", "State":"ACTIVE", "Name":"LoanAmount", "User ID":"admin", "Model ID":"MortgageLendingBAM", "TimingTimeZone":"America\/New_York", "E-mail":false, "LastEvalutionTime":"2008-12-03T21:00:00", "TimingInterval":"HOUR", "Permission":"FULL", "Pager":false, "Description":"Checking the average loan amount is not over $500,000.00", "TimingStartOffsetLocalized":"December 3,2008 12:00:00 AM", "Version":20070503100800, "ID":"LoanAmount", "LastEvalutionTimeLocalized":"December 3,2008 4:00:00 PM", "GeneratedContent":false, "NextEvalutionTimeLocalized":"December 3,2008 5:00:00 PM", "View Access":1, "NextEvalutionTime":"2008-12-03T22:00:00", "Modeled":false, "Dashboard":true, "Cell":false, "Creation Timestamp":"2008-12-03T17:58:58", "TimingStartOffset":"2008-12-03T00:00:00" }, { "Creation Timestamp Localized":"December 3,2008 4:30:02 PM", "TimingMultiple":1, "SituationTriggered":0, "TimingRepeat":"REPEATING", "State":"ACTIVE", "Name":"LoansCompleted", "User ID":"admin", "Model ID":"MortgageLendingBAM", "TimingTimeZone":"America\/New_York", "E-mail":false, "TimingInterval":"HOUR", "Permission":"FULL", "Description":"Loans Completed this month", "Pager":false, "TimingStartOffsetLocalized":"December 3,2008 12:00:00 AM", "Version":20070503100800, "ID":"LoansCompleted", "GeneratedContent":false, "NextEvalutionTimeLocalized":"December 3,2008 5:00:00 PM", "View Access":0, "NextEvalutionTime":"2008-12-03T22:00:00", "Modeled":false, "Dashboard":true, "Cell":false, "Creation Timestamp":"2008-12-03T21:30:02", "TimingStartOffset":"2008-12-03T00:00:00" } ], "Page Size":2, "Page Number":1}
The default content-type is application/json.
{ "description": "REST error response", "type": "object", "properties": { "Status Code" : {"type":"integer"}, "Error" : {"type":"string"}, } }
Example content:
{ "Error":"CWMDS6127E: Unsupported URI", "Status Code":404 }
Code | Description |
---|---|
200 OK |
Successful completion - requested data returned. Note that the list may be empty.
|
404 Not Found |
Resource not found or URL not supported.
|
400 Bad Request |
The request contains invalid parameters or is missing parameters and inputs.
|
500 Internal Server Error |
Internal error processing the request.
|
6.2
Parent Topic: Business Situation Alert List Resource