Query Alert Notes Using POST

Query Alert Notes Using POST

Data returned includes a Collection of Alert Notes

Request
URI
POST
https://{api_host}/api/alerts/notes/query
COPY
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


Request Body

The query spec used for looking up Alert Notes

alert-notes-query of type(s) application/json
Optional

Show optional properties

{
    "alert-query": {}
}
{
    "alert-query": {
        "activeOnly": false,
        "alertControlState": [
            "string"
        ],
        "alertCriticality": [
            "string"
        ],
        "alertDefinitionId": [
            "string"
        ],
        "alertId": [
            "string"
        ],
        "alertImpact": [
            "string"
        ],
        "alertName": "string",
        "alertStatus": [
            "string"
        ],
        "alertTypeSubtype": [
            {
                "subtypeIds": [
                    0
                ],
                "typeId": 0
            }
        ],
        "cancelTimeRange": {
            "endTime": 0,
            "startTime": 0
        },
        "compositeOperator": "string",
        "extractOwnerName": false,
        "groupId": "string",
        "groupingCondition": "string",
        "includeChildrenResources": false,
        "resource-query": {
            "adapterInstanceId": [
                "string"
            ],
            "adapterKind": [
                "string"
            ],
            "collectorId": [
                0
            ],
            "collectorName": [
                "string"
            ],
            "credentialId": [
                "string"
            ],
            "includeRelated": "string",
            "maintenanceScheduleId": [
                "string"
            ],
            "name": [
                "string"
            ],
            "parentId": [
                "string"
            ],
            "propertyConditions": {
                "conditions": [
                    {
                        "doubleValue": "number",
                        "key": "string",
                        "operator": "string",
                        "stringValue": "string"
                    }
                ],
                "conjunctionOperator": "string"
            },
            "propertyName": "string",
            "propertyValue": "string",
            "recentlyAdded": 0,
            "regex": [
                "string"
            ],
            "resourceHealth": [
                "string"
            ],
            "resourceId": [
                "string"
            ],
            "resourceKind": [
                "string"
            ],
            "resourceState": [
                "string"
            ],
            "resourceStatus": [
                "string"
            ],
            "resourceTag": [
                {
                    "category": "string",
                    "name": "string"
                }
            ],
            "statConditions": {
                "conditions": [
                    {
                        "doubleValue": "number",
                        "key": "string",
                        "operator": "string",
                        "stringValue": "string"
                    }
                ],
                "conjunctionOperator": "string"
            },
            "statKey": "string",
            "statKeyInclusive": false,
            "statKeyLowerBound": "number",
            "statKeyUpperBound": "number"
        },
        "resourceKind": "string",
        "startTimeRange": {
            "endTime": 0,
            "startTime": 0
        },
        "updateTimeRange": {
            "endTime": 0,
            "startTime": 0
        },
        "userId": "string",
        "userName": "string"
    },
    "alertNoteId": [
        "string"
    ],
    "alertNoteType": [
        "string"
    ],
    "compositeOperator": "string",
    "content": [
        "string"
    ],
    "creationTimeRange": {
        "endTime": 0,
        "startTime": 0
    },
    "userName": [
        "string"
    ]
}
alert-query
Required

Query for alerts by various criteria. Composition of filtering criteria controlled via the compositeOperator property. For Pagination see PageInfo For sorting see AlertField and SortOrder enumerations. If a sort field is not specified but pagination is requested the Alerts will be sorted by the alertId field.

array of string
alertNoteId
Optional

Filter based on Alert Note identifiers

array of string
alertNoteType
Optional

Filter based on alert note types

Possible values are : SYSTEM, USER, UNKNOWN,
string
compositeOperator
Optional

Indicates the composition of the filtering criteria. Either all of the filtering criteria apply together (AND operation) or any of the filtering criteria could be applied (OR operation) Defaults to AND. Note: backend only supports AND currently

Possible values are : AND, OR,
array of string
content
Optional

Filter based on note contents

creationTimeRange
Optional

creationTimeRange

array of string
userName
Optional

Filter based on user names

Authentication
This operation uses the following authentication methods.
Responses
200

The Alert Notes matching the query specified (Collection can be empty)

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


500

Error occurred while retrieving the Alert Notes

Operation doesn't return any data structure