Query Alert Notes

Query for Alert Notes based on specified criteria

Data returned includes a Collection of Alert Notes

Request

URI

POST

https://{api_host}/suite-api/api/alerts/notes/query

COPY

Query Parameters

integer

page

Optional

Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer

pageSize

Optional

Constraints: default: 1000

Expected number of entries per page

Request Body

The query spec used for looking up Alert Notes

alert-notes-query of type(s) application/json

Required

Show optional properties

{
    "alert-query": {}
}

"{\n  \"compositeOperator\" : \"AND\",\n  \"alertNoteId\" : [ ],\n  \"alert-query\" : {\n    \"compositeOperator\" : \"AND\",\n    \"alertId\" : [ \"24c93393-eba2-450c-85fb-105c6d97c7ab\" ],\n    \"activeOnly\" : false,\n    \"alertTypeSubtype\" : [ ],\n    \"alertCriticality\" : [ ],\n    \"alertStatus\" : [ ],\n    \"alertImpact\" : [ ],\n    \"alertControlState\" : [ ],\n    \"includeChildrenResources\" : false,\n    \"extractOwnerName\" : false\n  },\n  \"userName\" : [ ],\n  \"alertNoteType\" : [ ],\n  \"content\" : [ ]\n}"

object

alert-query

Required

Query for alerts by various criteria.
Composition of filtering criteria controlled via the compositeOperator property.
For Pagination see PageInfo
For sorting see AlertField and SortOrder enumerations.
If a sort field is not specified but pagination is requested the Alerts will be
sorted by the alertId field.

array of string

alertNoteId

Optional

Filter based on Alert Note identifiers

array of string

alertNoteType

Optional

Filter based on alert note types

Possible values are : SYSTEM, USER, UNKNOWN,

string

compositeOperator

Optional

Operations for Composite Conditions

Possible values are : AND, OR,

array of string

content

Optional

Filter based on note contents

object

creationTimeRange

Optional

Filter based on matching UTC cancel time

array of string

userName

Optional

Filter based on user names

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The Alert Notes matching the query specified (Collection can be empty)

Returns alert-notes of type(s) application/json

"{\n  \"alertNotes\" : [ {\n    \"id\" : \"ea3f7bcc-12f0-432b-9ba4-a808b14b8891\",\n    \"alertId\" : \"0d9ff4f7-1603-43c9-b51d-db2b5b47c65e\",\n    \"creationTimeUTC\" : 0,\n    \"type\" : \"USER\",\n    \"userId\" : \"2d8b511a-676a-4b9b-a032-aae9278c4f1f\",\n    \"userName\" : \"testUser\",\n    \"note\" : \"sample note\"\n  }, {\n    \"id\" : \"24c93393-eba2-450c-85fb-105c6d97c7ab\",\n    \"alertId\" : \"0d9ff4f7-1603-43c9-b51d-db2b5b47c65e\",\n    \"creationTimeUTC\" : 0,\n    \"type\" : \"SYSTEM\",\n    \"userId\" : \"2d8b511a-676a-4b9b-a032-aae9278c4f1f\",\n    \"userName\" : \"testUser\",\n    \"note\" : \"sample note\"\n  } ]\n}"

array of object

alertNotes

Optional

List of alert notes

array of object

links

Optional

Collection of links

object

pageInfo

Optional

Represents page information for a paged result

500

Error occurred while retrieving the Alert Notes

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"alert-query":"object"}' https://{api_host}/suite-api/api/alerts/notes/query

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Alerts Operations

GET

Get Alert Definitions