Add Alert Note Using POST

Add Alert Note Using POST

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

Request
URI
POST
https://{api_host}/api/alerts/{id}/notes
COPY
Path Parameters
string
id
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
Optional
{
    "content": "string"
}
string
content
Required

The alert note content

Authentication
This operation uses the following authentication methods.
Responses
201

The Alert Note created in the system

Returns alert-note of type(s) application/json
{
    "alertId": "string",
    "creationTimeUTC": 0,
    "extension": {
        "anyObjects": [
            {}
        ]
    },
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "note": "string",
    "type": "string",
    "userId": "string",
    "userName": "string"
}
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

extension
Optional

extension

string As uuid As uuid
id
Required

Identifier of the alert note

array of link
links
Optional

links

string
note
Required

Content of alert note

string
type
Required

Type of the 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