Get Alert Note

Get the requested Alert Note associated with an Alert

Example: GET /api/alerts/{id}/notes/{noteId}

Request

URI

GET

https://{api_host}/suite-api/api/alerts/{id}/notes/{noteId}

COPY

Path Parameters

string

Required

UUID of the Alert

string

noteId

Required

Alert Note identifier

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The requested Alert Note

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

"{\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}"

string As uuid As uuid

alertId

Required

Identifier of the associated alert

integer As int64 As int64

creationTimeUTC

Required

UTC time when the alert note created

object

extension

Optional

extension

string As uuid As uuid

Required

Identifier of the alert note

array of object

links

Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

string

note

Required

Content of alert note

string

type

Required

Indicates the type of an Alert Note

Possible values are : SYSTEM, USER, UNKNOWN,

string As uuid As uuid

userId

Optional

Identifier of the user who created the alert note

string

userName

Optional

Name of the user who created the alert note

404

No Alert is found or no note with the specified identifier

Operation doesn't return any data structure

500

Error occurred while retrieving the Alert Note

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alerts/{id}/notes/{noteId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Alerts Operations

GET

Get Alert Definitions

POST

Create Alert Definition

PUT

Update Alert Definition

POST

Query Alert Definitions

DELETE

Delete Alert Definition

GET

Get Alert Definition By Id

PUT

Disable Alert Definition In Policies

PUT

Enable Alert Definition In Policies

Delete Canceled Alerts

GET

Get Alert Contributing Symptoms