Get Alert Note Using GET

Get Alert Note Using GET

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

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

UUID of the Alert

string
noteId
Required

Alert Note identifier

Authentication
This operation uses the following authentication methods.
Responses
200

The requested Alert Note

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
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 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

On This Page
Alerts Operations
POST
Add Alert Note Using POST
POST
Create Alert Definition Using POST
DELETE
Delete Alert Definition Using DELETE
DELETE
Delete Alert Note Using DELETE
DELETE
Delete Canceled Alerts Using DELETE
PUT
Disable Alert Definition In Policies Using PUT
PUT
Enable Alert Definition In Policies Using PUT
GET
Get Alert Contributing Symptoms Using GET
GET
Get Alert Definition By Id Using GET
GET
Get Alert Definitions Using GET
GET
Get Alert Notes Using GET
GET
Get Alert Note Using GET
GET
Get Alerts Using GET
GET
Get Alert Types Using GET
GET
Get Alert Using GET
POST
Modify Alerts Using POST
POST
Query Alert Groups Using POST
POST
Query Alert Notes Using POST
POST
Query Alert Using POST
PUT
Update Alert Definition Using PUT