Get Alert Notes Using GET

Get Alert Notes Using GET

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

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

UUID of the Alert

Query Parameters
integer
page
Optional

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional

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
{
    "alertNotes": [
        {
            "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"
        }
    ],
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "sortBy": "string",
        "sortOrder": "string",
        "totalCount": 0
    }
}
array of alert-note
alertNotes
Optional

List of alert notes

array of link
links
Optional

Collection of links

pageInfo
Optional

Represents page information for a paged result


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