REST API - GET Alert Details for an Organization

Updated

This operation returns the details of the alerts associated with an organization.

Request

Syntax

GET <webservice>/AlertRule?organizationId={organizationId} HTTP/1.1

Host: <host name>

Accept: application/xml

Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

organizationId

The ID for the company or the organization. If the organization ID is not known, use the GET Organization API to retrieve it. The organization ID is the ID in the shortName element.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

name

The name of the alert.

alert

id

The system-generated ID assigned to the alert.

alert

id

The ID assigned to the alert category.

Valid values are:

  • 1, for Job Management

  • 2, for Configuration

  • 3, for Media Management

  • 5, for Software Updates

  • 8, for Operation

  • 9, for Others

alertCategory

name

The name of the alert category.

alertCategory

notifType

The notification type for the alert. If multiple notification types exist, the sum of the notification types is returned. For example, the parameter to deliver alerts through email and through the console is val = "8193".

Valid values are:

  • 1, for email

  • 4, for SNMP

  • 8, for event viewer

  • 512, for save to disk

  • 1024, for RSS feeds

  • 8192, for console alerts

  • 32768, for SCOM

  • 65536, for workflow

  • 131072, for content indexing

alertList

description

The alert description.

alertList

organizationId

The ID of the organization.

alertList

createdTime

alertList

status

The status for the alert. If multiple status types are needed, then the sum of individual status values are used. For example, a status value of 2193 means the alert is disabled (1), has the option to send individual notifications selected (16), and is a system created alert (2048).

Valid individual status values are:

  • 1: Alert is currently disabled.

  • 4: Alert is job based, schedule, or policy based alert.

  • 16: Option to send individual notifications for the alert is selected.

  • 128: Alert is subscription based.

  • 256: The alert is permanent and cannot be deleted (system-created alerts only).

  • 1024: Option to process discovered virtual machines is selected.

alertList

id

The ID assigned to the alert type.

Valid values are:

  • 1, for Data Aging

  • 2, for Auxiliary Copy

  • 3, for Data Protection

  • 4, for Data Recovery

  • 5, for Disaster Recovery Backup

  • 6, for Data Verification

  • 7, for Media Inventory

  • 8, for scheduled export

  • 9, for Media Erase

  • 10, for Client

  • 11, for agents

  • 12. for CommCell

  • 13, for MediaAgents

  • 14, for Schedules

  • 15, for Storage Policy

  • 16, for Library

  • 17, for Library Management

  • 18, for VaultTracker

  • 19, for Download Software

  • 20, for Install Updates

  • 21, for Device Status

  • 22, for Erase Data

  • 23, for application exchange

  • 24, for Updates Available for Download

  • 25, for File Replication

  • 26, for Upgrades and Service Packs

  • 27, for Data Classification

  • 28, for Continuous Data Replication

  • 29, for offline content indexing

  • 30, for SharePoint

  • 52, for Report

  • 53, for Information Management

  • 54, for Media Refreshing

  • 55, for DeDup DB Reconstruction

  • 57, for Log Monitoring 58, for Event Viewer Events

  • 59, for Client Group

  • 60, for License

  • 61, for Backup Copy Workflow

  • 62, for log monitoring for Windows events

  • 63, for Workflow

  • 64, for Virtualize Me

  • 65, for custom queries

  • When the alertCatagory element id parameter equals 9, the alertType element id parameter equals the query ID.

alertType

name

The name of the alert type.

alertType

companyId

The system-generated ID assigned to the organization.

organization

companyName

The name of the organization.

organization

Examples

Sample Request

GET <webservice>/AlertRule?organizationId=20 HTTP/1.1

Host: client.mydomain.com

Accept: application/xml

Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6

0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f

8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f

40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7

68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323

3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<CVGui_AlertListResp myReceiveTotal="0" myCreatedTotal="0">

<alertList notifType="131073" description="Default backup job failed Alert" organizationId="20" createdTime="1564045994" status="2048">

<creator name="john" id="32"/>

<alertType name="Data Protection" id="3"/>

<alert name="Backup job failed" id="103"/>

<organization companyId="20" companyName="Company3"/>

<alertCategory name="Job Management" id="1"/>

</alertList>

<alertList notifType="131073" description="Default backup job succeeded Alert" organizationId="20" createdTime="1564045994" status="2048">

<creator name="john" id="32"/>

<alertType name="Data Protection" id="3"/>

<alert name="Backup job succeeded" id="103"/>

<organization companyId="20" companyName="Company3"/>

<alertCategory name="Job Management" id="1"/>

</alertList>

<alertList notifType="131073" description="Default restore job succeeded Alert" organizationId="20" createdTime="1564045994" status="2048">

<creator name="john" id="32"/>

<alertType name="Data Recovery" id="3"/>

<alert name="Restore job succeeded" id="103"/>

<organization companyId="20" companyName="Company3"/>

<alertCategory name="Job Management" id="1"/>

</alertList>

<alertList notifType="131073" description="Default restore job failed Alert" organizationId="20" createdTime="1564045994" status="2048">

<creator name="john" id="32"/>

<alertType name="Data Recovery" id="3"/>

<alert name="Restore job failed" id="103"/>

<organization companyId="20" companyName="Company3"/>

<alertCategory name="Job Management" id="1"/>

</alertList>

</CVGui_AlertListResp>