Get Alert Details

Select

SaaS

Customer Managed

This operation returns the details associated with an alert.

More Details

Path Parameters

• alertId2 string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• alertDetail object

  alertSeverity integer

  eventCriteriaXML string

  escalationSeverity integer

  checkForEventParams integer

  customQueryDetailsXml string

  alertTokenRuleGroupXml string

  xmlEntityList string

  periodicNotificationInterval integer

  securityAssociations object

  ownerAssociations object

  criteria object[]

  reportId integer

  criteriaId integer

  esclationLevel integer

  persistTimeSeconds integer

  reportingOptions integer

  delayTimeSeconds integer

  value string

  taskId integer

  locale object

  localeName string

  localeID integer

  alert object

  notifType integer

  GUID string

  description string

  createdTime integer

  origCCId integer

  escNotifType integer

  status integer

  creator object

  name string

  id integer

  alertType object

  name string

  id integer

  alert object

  name string

  id integer

  alertCategory object

  name string

  id integer

  userGroupList object[]

  id2 integer

  id1 integer

  name string

  criteriasSelected integer[]

  reportingParams object

  persistTimeSeconds integer

  reportingOptions integer

  delayTimeSeconds integer

  appTypeFilters object

  regularNotifications integer[]

  notifMsgs object[]

  notifOptions integer

  notifType integer

  esclationLevel integer

  notifMessage string

  messageFormat integer

  notifMessageHtml string

  localeId integer

  saveAlertToDisk object

  password string

  alertLocation string

  cvpassword string

  useNetworkShare integer

  loginName string

  impersonateUser integer

  feeds object

  seperateIndex boolean

  baseLocation string

  selectedChannel string

  rssFeedLocation string

  entity object

  srmReportSet integer

  type integer

  srmReportType integer

  clientSidePackage boolean

  _type_ integer

  consumeLicense boolean

  alertProperties object

{
  "alertDetail": {
    "alertSeverity": 0,
    "eventCriteriaXML": "string",
    "escalationSeverity": 0,
    "checkForEventParams": 0,
    "customQueryDetailsXml": "string",
    "alertTokenRuleGroupXml": "string",
    "xmlEntityList": "string",
    "periodicNotificationInterval": 0,
    "securityAssociations": {
      "ownerAssociations": {}
    },
    "criteria": [
      {
        "reportId": 0,
        "criteriaId": 0,
        "esclationLevel": 0,
        "persistTimeSeconds": 0,
        "reportingOptions": 0,
        "delayTimeSeconds": 0,
        "value": "string",
        "taskId": 0
      }
    ],
    "locale": {
      "localeName": "string",
      "localeID": 0
    },
    "alert": {
      "notifType": 0,
      "GUID": "string",
      "description": "string",
      "createdTime": 0,
      "origCCId": 0,
      "escNotifType": 0,
      "status": 0,
      "creator": {
        "name": "string",
        "id": 0
      },
      "alertType": {
        "name": "string",
        "id": 0
      },
      "alert": {
        "name": "string",
        "id": 0
      },
      "alertCategory": {
        "name": "string",
        "id": 0
      }
    },
    "userGroupList": [
      {
        "id2": 0,
        "id1": 0,
        "name": "string"
      }
    ],
    "criteriasSelected": [
      0
    ],
    "reportingParams": {
      "persistTimeSeconds": 0,
      "reportingOptions": 0,
      "delayTimeSeconds": 0
    },
    "appTypeFilters": {},
    "regularNotifications": [
      0
    ],
    "notifMsgs": [
      {
        "notifOptions": 0,
        "notifType": 0,
        "esclationLevel": 0,
        "notifMessage": "string",
        "messageFormat": 0,
        "notifMessageHtml": "string",
        "localeId": 0,
        "saveAlertToDisk": {
          "password": "string",
          "alertLocation": "string",
          "cvpassword": "string",
          "useNetworkShare": 0,
          "loginName": "string",
          "impersonateUser": 0
        },
        "feeds": {
          "seperateIndex": true,
          "baseLocation": "string",
          "selectedChannel": "string",
          "rssFeedLocation": "string"
        },
        "entity": {
          "srmReportSet": 0,
          "type": 0,
          "srmReportType": 0,
          "clientSidePackage": true,
          "_type_": 0,
          "consumeLicense": true
        }
      }
    ],
    "alertProperties": {}
  }
}

GET /alertrule/:alertid2    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

alertId2 — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/AlertRule/:alertId2' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'