OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

PDF

GET method for AlertPolicies(Id)

This method returns the details of a specific policy.

Description

Returns the details of a specific policy.

Privilege

VIEW

HTTP response codes

200

Example

Input:

Output:
{
  "@odata.context": "$metadata#AlertService.AlertPolicy/$entity",
  "@odata.id": "/api/AlertService/AlertPolicies(314)",
  "Id": 314,
  "Name": "Default OnDemand Health Policy",
  "Description": "This policy is applicable to all devices. A health task will be triggered if category is for system health.",
  "Enabled": true,
  "DefaultPolicy": true,
  "PolicyData": {
    "Catalogs": [
      {
        "CatalogName": "iDRAC",
        "Categories": [
          3300
        ],
        "SubCategories": [
          0
        ]
      }
    ],
    "Severities": [
      1,
      2,
      4,
      8,
      16
    ],
    "Devices": [],
    "DeviceTypes": [],
    "Groups": [
      4
    ],
    "Schedule": {
      "StartTime": null,
      "EndTime": null,
      "CronString": null
    },
    "Actions": [
      {
        "Id": 1,
        "Name": "OnDemandHealth",
        "ParameterDetails": [],
        "TemplateId": 80
      }
    ]
  },
  "State": true,
  "Visible": true,
  "PolicyActions": [
    {
      "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyActions"
    }
  ],
  "PolicyCriteria": [
    {
      "@odata.id": "/api/AlertService/AlertPolicies(314)/PolicyCriteria"
    }
  ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
Id	Event record ID.
Name	Name associated with the policy.
Description	Description associated with the policy.
Enabled	Indicates if the policy is enabled or disabled.
DefaultPolicy	Indicates if the policy is the default policy or pre-seeded.
State	State associated with the policy.
Visible	Indicate if the policy is visible or hidden.
PolicyData
CatalogName	Name of the catalogs associated with the policy. This field is checked during policy evaluation.
Categories	Name of the categories associated with the policy. This field is checked during policy evaluation.
SubCategories	Name of the subcategories associated with the policy. If defined, this field is checked during policy evaluation.
Severities	List of severities associated to the policy. This field is checked during policy evaluation.
Devices	List of devices associated to the policy. This field is checked during policy evaluation.
DevicesTypes	List of devices types associated to the policy.
Groups	List of groups associated to the policy. This field is checked during policy evaluation.
Schedule
StartTime	Start event-time to verify. This value indicates the start date and time for policy validity. If defined. This field is checked during policy evaluation.
EndTime	End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is checked during policy evaluation.
CronString	CRON string associated to the policy. This field indicates a special CRON that can be applied to the policy to indicate values such as the days for which the policy is valid.
Actions
Id	ID of action.
Name	Name associated with the action.
ParameterDetails	Extra parameters that can be used for the action.
TemplateId	ID of the template associated with the action.
PolicyActions	Link to the list of actions that can be triggered for the policy.
PolicyCriteria	Link to the criteria for the evaluation of the alert contents with the policy contents. This evaluation determines if the policy is valid and if any actions are triggered.