Getting a list of notification profiles

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of information about notification profiles, such as profile names and notification event levels.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/NotificationProfile

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of NotificationProfile objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

NotificationProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "notificationEventLevels":["...", ...],
        "useAllCategory":"...",
        "notificationCategories":["...", ...],
        "mailRecipientType":"..."
}

NotificationProfile (Type: NotificationProfile)

Attribute	Type	Description
instanceID	string	ID of the condition profile for the notification condition
profileName	string	Name of the condition profile for the notification condition
description	string	Description
notificationEventLevels	enum[]	Event level of the events to be reported (For details about the valid values, see the table EventSeverityType in List of enumerators.)
useAllCategory	boolean	Whether or not to use all event categories as notification conditions. To use all event categories as notification conditions, specify "true". To use only specific event categories as notification conditions, specify "false".
notificationCategories	enum[]	Category of the events that can be used in notification conditions. Specify this item only if useAllCategory is "false". (For details about the valid values, see the table EventCategoryType in List of enumerators.)
mailRecipientType	enum	Email transmission type (For details about the valid values, see the table MailRecipientType in List of enumerators.) TO CC BCC

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/NotificationProfile
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 11 Aug 2016 17:55:27 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8113b75377dac59b7c48ee2b947b20d3bbc11f_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : "notificationProfile#ab5ae064-5888-4a51-b397-79adf728666b",
    "profileName" : "Profile Name@20160812025527454",
    "description" : "description",
    "notificationEventLevels" : [ "CRITICAL", "WARNING" ],
    "useAllCategory" : false,
    "notificationCategories" : [ "PERFORMANCE" ],
    "mailRecipientType" : "TO"
  } ],
  "count" : 1
}