WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
POST /situation/alerts/config/{ID}?{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.
|
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 |
|
ID |
string |
This is the ID based on the name of this Dynamic Alert. |
|
|
string |
The model ID this alert is based on |
|
|
string |
The version of the model this alert is based on |
|
Name |
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. |
|
State |
string |
The state of this situation. Possible states are: inactive,
active, invalid. |
|
Description |
string |
The display description given by the user |
|
Subject |
string |
The subject line of the alert message |
|
Body |
string |
The body of the alert message |
|
GeneratedContent |
boolean |
This will indicate if the body and subject were system
generated, Default is false. |
|
View Access |
number |
This will control access to view and subscriptions to this
alert. 0 = private, 1 = public, Default is 0 (private). |
|
TimingInterval |
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 |
|
TimingStartOffset |
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 |
|
TimingMultiple |
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. |
|
TimingRepeat |
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 |
|
TimingKPI |
string |
Describes the ID of the KPI to use for the period time
evaluations, required when TimingRepeat=ONCEINPERIOD and
TimingInterval=PERIOD. |
|
TimingTimeZone |
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. |
|
TriggerArray |
array |
Describes a conditional trigger. All triggers will be 'anded'
together to determine if the situation will fire. Each trigger is described as
an array item of the following properties. |
|
|
|
string |
The system generated ID, must be used during an update of this
trigger. Indicates that this is a new trigger being added if TriggerID is not
included with this trigger. All existing triggers ID's not included will be
removed from the list of triggers for this situation. |
|
CheckKPI |
string |
Indicates which KPI should be used in this evaluation |
|
CheckPrediction |
string |
Indicates which Prediction KPI to be used in this evaluation |
|
CheckPredictionType |
string |
Indicates which Prediction KPI type to be used in this
evaluation. Types are: end: for the end of the prediction period, any: for any value within the prediction set |
|
CheckCondition |
string |
Indicates which type of condition to use. The operations will be
done using the check KPI and the check field. |
|
CheckFieldType |
string |
Indicates what type of field will to be compared against the
KPI. |
|
CheckField |
string |
Indicates actual value or where to get the value to use in the
evaluation. When CheckFieldType is 'value' check field will be the actual
value to use. When CheckFieldType is 'target' check field will be
ignored." When CheckFieldType is 'range' check field will be the name of
the KPI range. |
|
array |
Describes subscribers to this situation. Each subscription is
describe as an array item of the following setting. |
|
|
|
string |
The user who is subscribed to this alert |
|
|
string |
The alert format is E-mail |
|
|
boolean |
The alert format is Dashboard |
|
|
boolean |
The alert format is Cell |
|
|
boolean |
The alert format is Pager |
{ "description": "Dynamic Alert update", "type": "object", "properties": { "ID":{"type":"string", "optional": false, "description": "This is the ID based on the name of this Dynamic Alert."}, "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."}, "Subject":{"type":"string", "optional": false, "description": "The subject line of the alert message."}, "Body":{"type":"string", "optional": false, "description": "The body of the alert message."}, "GeneratedContent":{"type":"boolean", "optional":true, "description":"This will indicate if the body and subject were system generated, default is false."}, "View Access":{"type":"number", "optional": true, "description": "This will 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, 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 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 util 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."}, "TriggerArray": { "type":"array", "optional":true, "description": "Describes a conditional trigger. All triggers will be 'anded' together to determin if the situation will fire. During the udpate this will become the new list, with updates being done to existing triggers and deleting those not on this list. Each trigger is describe as an array item of the following properties." "items" : { "properties" : { "CheckKPI": {"type":"string", "optional": false, "description": "Indicates which KPI should be used in this evaluation" }, "CheckPrediction": {"type":"string", "optional": true, "description": "Indicates which Prediction KPI to be used in this evaluation" }, "CheckPredictionType": {"type":"string", "optional": true, "description": "Indicates which Prediction KPI type to be used in this evaluation. Types are: end: for the end of the prediction period, any: for any value within the prediction set", "enum":["end", "any"] }, "CheckCondition": {"type":"string", "optional": false, "description": "Indicates which type of condition to use. The operations will be done using the check KPI and the check field.", "enum":["equals", "above", "aboveEquals", "below", "belowEquals", "leaveRangeHigh", "leaveRangeLow", "enterRange"] }, "CheckFieldType": {"type":"string", "optional": false, "description": "Indicates what type of field will to be compared against the KPI." "enum":["value", "target", "range"] }, "CheckField": {"type":"string", "optional": true, "description": "Indicates actual value or where to get the value to use in the evaluation. When CheckFieldType is 'value' check field will be the actual value to use. When CheckFieldType is 'target' check field will be ignored. When CheckFieldType is 'range' check field will be the name of the KPI range." } "TriggerID": {"type":"string", "optional": true, "description": "The system generated ID, must be used during an update of this trigger. Indicates that this is a new trigger being added if TriggerID is not included with this trigger. All existing triggers ID's not included will be removed from the list of triggers for this situation." } } } }, "Alert Subscription Array": { "type":"array", "optional":true, "description": "Describes subscribers to this situation. During the udpate this will become the new list, with updates being done to existing subsribers and deleting those not on this list. Each subscription is describe as an array item of the following setting." "items" : { "properties" : { "User ID": {"type":"string", "optional": true, "description": "The user who is subscribed to this alert" }, "E-mail": {"type":"boolean", "optional": true, "description": "The alert format is E-mail" }, "Dashboard": {"type":"boolean", "optional": true, "description": "The alert format is Dashboard" }, "Cell": {"type":"boolean", "optional": true, "description": "The alert format is Cell" }, "Pager": {"type":"boolean", "optional": true, "description": "The alert format is Pager" }, } } } } }
Example content:
{ "ID":"LoanAmount", "State":"ACTIVE", "Name":"LoanAmount", "Description":"Checking the average loan amount is not over $200,000.00", "User ID":"admin", "Model ID":"MortgageLendingBAM", "Subject":"LoanAmount", "Body":"%/Average_Application_Loan_Amount__x0028__x0024__x0029_/name% Above $200,000.00", "Version":20070503100800, "GeneratedContent":true, "View Access":1, "Locale":"en", "TimingTimeZone":"America/New_York", "TimingInterval":"HOUR", "TimingStartOffset":"2008-12-03T00:00:00", "TimingMultiple":1, "TimingRepeat":"REPEATING", "TriggerArray": [ { "TriggerID":"B44A759009C312C1F24C0FEC", "CheckField":"500000", "CheckFieldType":"value", "CheckKPI":"Average_Application_Loan_Amount__x0028__x0024__x0029_", "CheckCondition":"above" } ], "Alert Subscription Array": [ { "User ID":"admin", "E-mail":false, "Dashboard":true, "Cell":false, "Pager":false } ], }
The default content-type is application/json.
The following table lists all parameters in the JSON output:
Parameter Name |
Type |
Description |
|
ID |
string |
This is the ID based on the name of this Dynamic Alert |
|
|
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 |
|
|
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. |
|
|
string |
The model ID this alert is based on |
|
|
string |
The version of the model this alert is based on |
|
Name |
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. |
|
State |
string |
The state of this situation. Possible states are: inactive,
active, invalid. |
|
Description |
string |
The display description given by the user |
|
Subject |
string |
The subject line of the alert message |
|
Body |
string |
The body of the alert message |
|
GeneratedContent |
boolean |
This will indicate if the body and subject were system
generated, Default is false. |
|
View Access |
number |
This will control access to view and subscriptions to this
alert. 0 = private, 1 = public, Default is 0 (private). |
|
TimingInterval |
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 |
|
TimingStartOffset |
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 |
|
TimingMultiple |
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. |
|
TimingRepeat |
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 |
|
TimingKPI |
string |
Describes the ID of the KPI to use for the period time
evaluations, required when TimingRepeat=ONCEINPERIOD
and TimingInterval=PERIOD. |
|
TimingTimeZone |
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. |
|
TimingStartOffsetLocalized |
string |
The TimingStartOffset timestamp in the
localized formatted form. |
|
LastEvalutionTime |
string |
Describes the time of the last evaluation of the conditions. The
time format is yyyy-mm-ddThh:mm:ss |
|
LastEvalutionTimeLocalized |
string |
Describes the time of the last evaluation of the conditions. The
time will be in the localized formatted form. |
|
NextEvalutionTime |
string |
Describes the time of the next evaluation of the conditions. The
time format is yyyy-mm-ddThh:mm:ss |
|
NextEvalutionTimeLocalized |
string |
Describes the time of the next evaluation of the conditions. The
time will be in the localized formatted form. |
|
SituationTriggered |
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. |
|
Creation Timestamp |
string |
Describes the create time of this alert definition. The time
format is yyyy-mm-ddThh:mm:ss |
|
Creation Timestamp Localized |
string |
Describes the create time of this alert definition. The time
will be in the localized formatted form. |
|
TriggerArray |
array |
Describes a conditional trigger. All triggers will be 'anded' together to determine if the situation will fire.
Each trigger is described as an array item of the following properties. |
|
|
CheckKPI |
string |
Indicates which KPI should be used in this evaluation |
|
CheckPrediction |
string |
Indicates which Prediction KPI to be used in this evaluation |
|
CheckPredictionType |
string |
Indicates which Prediction KPI type to be used in this
evaluation. Types are: end: for the end of the prediction period, any: for any value within the prediction set |
|
CheckCondition |
string |
Indicates which type of condition to use. The operations will be
done using the check KPI and the check field. |
|
CheckFieldType |
string |
Indicates what type of field will to be compared against the
KPI. |
|
|
string |
The system generated ID, must be used during an update |
|
CheckField |
string |
Indicates actual value or where to get the value to use in the
evaluation. When CheckFieldType is 'value' check
field will be the actual value to use. When CheckFieldType is 'target' check
field will be ignored." When CheckFieldType is 'range' check
field will be the name of the KPI range. |
|
array |
Describes subscribers to this situation. Each subscription is
describe as an array item of the following setting. |
|
|
|
string |
The user who is subscribed to this alert |
|
|
string |
The alert format is E-mail |
|
|
boolean |
The alert format is Dashboard |
|
|
boolean |
The alert format is Cell |
|
|
boolean |
The alert format is Pager |
|
array |
An optional list of warning messages which will be included when
the situation is in the "invalid" state. This parameter only
applies to GET requests. |
|
|
|
|
The warning message |
{ "description": "Dynamic Alert configuration details", "type": "object", "properties": { "ID":{"type":"string", "optional": false, "description": "This is 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." }, "Subject":{"type":"string", "optional": false, "description": "The subject line of the alert message."}, "Body":{"type":"string", "optional": false, "description": "The body of the alert message."}, "GeneratedContent":{"type":"boolean", "optional":true, "description":"This will indicate if the body and subject were system generated, default is false."}, "View Access":{"type":"number", "optional": true, "description": "This will 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, 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 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."}, "LastEvalutionTime": {"type":"string", "optional": true, "description": "Describes the time of the last evaluation of the conditions. The time format is yyyy-mm-ddThh:mm:ss "}, "LastEvalutionTimeLocalized": {"type":"string", "optional": true, "description": "Describes the time of the last evaluation of the conditions. The time will be in the localized formatted form. "}, "NextEvalutionTime": {"type":"string", "optional": true, "description": "Describes the time of the next evaluation of the conditions. The time format is yyyy-mm-ddThh:mm:ss "}, "NextEvalutionTimeLocalized": {"type":"string", "optional": true, "description": "Describes the time of the next evaluation of the conditions. The time will be 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. " }, "TriggerArray":{ "type":"array", "optional":true, "description": "Describes a conditional trigger. All triggers will be 'anded' together to determin if the situation will fire. Each trigger is describe as an array item of the following properties." "items" : { "properties" : { "CheckKPI": {"type":"string", "optional": false, "description": "Indicates which KPI should be used in this evaluation" }, "CheckPrediction": {"type":"string", "optional": true, "description": "Indicates which Prediction KPI to be used in this evaluation" }, "CheckPredictionType": {"type":"string", "optional": true, "description": "Indicates which Prediction KPI type to be used in this evaluation. Types are: end: for the end of the prediction period, any: for any value within the prediction set", "enum":["end", "any"] }, "CheckCondition": {"type":"string", "optional": false, "description": "Indicates which type of condition to use. The operations will be done using the check KPI and the check field.", "enum":["equals", "above", "aboveEquals", "below", "belowEquals", "leaveRangeHigh", "leaveRangeLow", "enterRange"] }, "CheckFieldType": {"type":"string", "optional": false, "description": "Indicates what type of field will to be compared against the KPI." "enum":["value", "target", "range"] }, "CheckField": {"type":"string", "optional": true, "description": "Indicates actual value or where to get the value to use in the evaluation. When CheckFieldType is 'value' check field will be the actual value to use. When CheckFieldType is 'target' check field will be ignored." When CheckFieldType is 'range' check field will be the name of the KPI range. }, "TriggerID": {"type":"string", "optional": true, "description": "The system generated ID, must be used during an update" } } } }, "Alert Subscription Array":{ "type":"array", "optional":true, "description": "Describes subscribers to this situation.Each subscription is describe as an array item of the following setting." "items" : { "properties" : { "User ID": {"type":"string", "optional": true, "description": "The user who is subscribed to this alert" }, "E-mail": {"type":"boolean", "optional": true, "description": "The alert format is E-mail" }, "Dashboard": {"type":"boolean", "optional": true, "description": "The alert format is Dashboard" }, "Cell": {"type":"boolean", "optional": true, "description": "The alert format is Cell" }, "Pager": {"type":"boolean", "optional": true, "description": "The alert format is Pager" }, } } } "Warnings":{ "type":"array", "optional":true, "description": "An optional list of warning messages which will be included when the situation is in the "invalid" state. This parameter only applies to GET requests." "items" : {"properties": {"Warning":{"type":"string"}}} } } }
Example content:
{ "ID":"LoanAmount", "Creation Timestamp Localized":"December 3,2008 12:58:58 PM", "TimingMultiple":1, "SituationTriggered":0, "TimingRepeat":"REPEATING", "TriggerArray": [ { "CheckField":"500000", "TriggerID":"B44A759009C312C1F24C0FEC", "CheckFieldType":"value", "CheckKPI":"Average_Application_Loan_Amount__x0028__x0024__x0029_", "CheckCondition":"above" } ], "Alert Subscription Array": [ { "User ID":"admin", "E-mail":false, "Dashboard":true, "Cell":false, "Pager":false } ], "State":"ACTIVE", "Name":"LoanAmount", "User ID":"admin", "Model ID":"MortgageLendingBAM", "Locale":"en", "TimingTimeZone":"America\/New_York", "E-mail":false, "LastEvalutionTime":"2008-12-04T15:00:00", "Subject":"LoanAmount", "TimingInterval":"HOUR", "Permission":"FULL", "Pager":false, "Body":"%\/Average_Application_Loan_Amount__x0028__x0024__x0029_\/name% Above $500,000.00", "Description":"Checking the average loan amount is not over $500,000.00", "TimingStartOffsetLocalized":"December 3,2008 12:00:00 AM", "Version":20070503100800, "LastEvalutionTimeLocalized":"December 4,2008 10:00:00 AM", "GeneratedContent":true, "NextEvalutionTimeLocalized":"December 4,2008 11:00:00 AM", "View Access":1, "NextEvalutionTime":"2008-12-04T16:00:00", "Modeled":false, "Dashboard":true, "Cell":false, "Creation Timestamp":"2008-12-03T17:58:58", "TimingStartOffset":"2008-12-03T00:00:00" }
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: Dynamic Business Situation Alert Configuration Resource