Get Alert Notes

Get Alert Notes

Data includes a Collection of Alert Notes
Example: GET /api/alerts/{id}/notes

Request
URI
GET
https://{api_host}/suite-api/api/alerts/{id}/notes
COPY
Path Parameters
string
id
Required

UUID of the Alert

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

Authentication
This operation uses the following authentication methods.
Responses
200

All the Alert Notes for the specified Alert

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}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
alertNotes
Optional

List of alert notes


404

No Alert is found with the specified identifier

Operation doesn't return any data structure

500

Error occurred while retrieving the Alert Notes

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alerts/{id}/notes
On This Page
Alerts Operations
GET
Get Alert Definitions
PUT
Update Alert Definition
POST
Create Alert Definition
PUT
Enable Alert Definition In Policies
PUT
Disable Alert Definition In Policies
GET
Get Alerts
POST
Modify Alerts
GET
Get Alert Notes
POST
Add Alert Note
POST
Query Alert
POST
Query Alert Notes
POST
Query Alert Groups
POST
Query Alert Definitions
GET
Get Alert
GET
Get Alert Note
DELETE
Delete Alert Note
GET
Get Alert Types
GET
Get Alert Contributing Symptoms
GET
Get Alert Definition By Id
DELETE
Delete Alert Definition
DELETE
Delete Canceled Alerts