Getting a list of mail addresses

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of information about email addresses, such as the email addresses and assigned notification profiles.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/MailAddress

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 MailAddress 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.

MailAddress

{
        "instanceID":"...",
        "email":"...",
        "isActive":"...",
        "description":"...",
        "assignedConditionProfilesIDs":["...", ...],
        "assignedConditionProfiles":["...", ...]
}

MailAddress (Type: MailAddress)

Attribute	Type	Description
instanceID	string	ID of the mail address
email	string	Mail address
isActive	boolean	Whether or not the email addresses are enabled as notification destinations. For enabled addresses, "true" is set. For disabled addresses, "false" is set.
description	string	Description
assignedConditionProfilesIDs	string[]	ID of the condition profile for the notification condition in which this email address is specified as the destination address
assignedConditionProfiles	string[]	Name of the condition profile for the notification condition in which this email address is specified as the destination address

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/MailAddress
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 03 Aug 2016 02:02:32 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a61560c2eac97b0564aec48d2883daf39c0dfdf_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" : "mailAddress#ff6bb9a9-cb64-4f6d-8041-5908744738eb",
    "email" : "admin@example.com",
    "isActive" : true,
    "description" : "description",
    "assignedConditionProfilesIDs" : [ ],
    "assignedConditionProfiles" : [ ]
  } ],
  "count" : 1
}