Add Alert Note

Add a Note to an Alert

Data returned is the Alert Note created in the system.
Example: POST /api/alerts/{id}/notes

Request

URI

POST

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

COPY

Path Parameters

string

Required

The indentifier of the Alert t which the Note need to be added

Request Body

The Content of the note

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

Required

Show optional properties

{
    "content": "string"
}

"{\n  \"content\" : \"sample note\"\n}"

string

content

Required

The alert note content

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

The Alert Note created in the system

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 with the specified identifier

Operation doesn't return any data structure

500

Error occurred while creating the Alert Note

Operation doesn't return any data structure

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Alerts Operations

GET

Get Alert Definitions