type | String Optional. Specifies the type of problems you want returned. The default value is RULE_VIOLATION. | ||
Set to | To look for | ||
RULE_VIOLATION | Rule violation events. | ||
SLA_VIOLATION | SLA violation events. | ||
ANY_TYPE | Any type of problems. | ||
description | String Optional. Specifies the description of the problems that you want returned. The closest match to the provided value is returned. For example, a value of abc will match all strings that contain abc. For an exact match, use quotation marks (“abc”). | ||
timePeriod | String Required when no startDate and endDate are provided. Defines the time period for which to return problems. For example, if the current date is January 10, 2009 and you specify LAST_YEAR as time period, the service will return data only from January 1 to January 10, 2009. | ||
Set to | To retrieve problems from | ||
LAST_HOUR | The current hour. | ||
LAST_DAY | The current day. | ||
LAST_WEEK | The current week. | ||
LAST_MONTH | The current month. | ||
LAST_QUARTER | The current quarter. | ||
LAST_YEAR | The current year. | ||
startDate | String Optional. Specifies the start of the time period for which to return problems. The time must be in the following format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. | ||
endDate | String Optional. Specifies the end of the time period for which to return problems. The time must be in the following format: yyyy-MM-dd’T’HH:mm:ss.SSSZ. | ||
SLAOn | String Optional. Specifies whether the rule is of SLA type or not. | ||
Set to | To specify that | ||
true | The rule has an SLA attribute defined. | ||
false | The rule does not have an SLA attribute defined. | ||
SLACustomer | String Optional. Specifies the customer name associated with the Service Level Agreement (SLA) of the rule that was violated to cause the problem event. | ||
severity | String Optional. Specifies the severity level assigned to the rule that was violated to cause the problem event. | ||
duration | String Optional. Specifies the duration of the problem event in milliseconds. | ||
alertUser | String Optional. Specifies the user(s) notified when the problem occurs. | ||
ruleStatus | String Optional. Specifies the rule status for the problem. | ||
Set to | To look for problems | ||
inCompliance | In compliance with the rule. | ||
outOfCompliance | Out of compliance with the rule. | ||
relation | String Optional. Specifies the name of the process model to which the problem is related. | ||
category | String Optional. Specifies the category of problems that you want returned. If the parameter is not set, the query retrieves only business data. | ||
Set to | To get | ||
0 | Problems data of business type. | ||
1 | Problems data of system type. | ||